From 5a819461140f955d98a5ccebaa6cab7d307b6063 Mon Sep 17 00:00:00 2001 From: Subhankar Maiti Date: Fri, 2 May 2025 10:18:33 +0530 Subject: [PATCH 1/2] Release v4.6.0 --- .version | 2 +- CHANGELOG.md | 9 + docs/assets/hierarchy.js | 3 +- docs/assets/highlight.css | 169 +- docs/assets/icons.js | 37 +- docs/assets/main.js | 2532 +------------ docs/assets/navigation.js | 3 +- docs/assets/search.js | 3 +- docs/assets/style.css | 3159 +++++++++-------- docs/classes/TimeoutError.html | 503 +-- docs/classes/Types.Auth.html | 2631 +------------- docs/classes/Types.BaseError.html | 518 +-- docs/classes/Types.CredentialsManager.html | 784 +--- docs/classes/Types.Users.html | 664 +--- docs/classes/Types.WebAuth.html | 725 +--- docs/classes/default.html | 896 +---- docs/enums/LocalAuthenticationLevel.html | 472 +-- docs/enums/LocalAuthenticationStrategy.html | 423 +-- ...SafariViewControllerPresentationStyle.html | 779 +--- docs/functions/Auth0Provider.html | 494 +-- docs/functions/useAuth0.html | 283 +- docs/hierarchy.html | 254 +- docs/index.html | 2138 ++--------- docs/interfaces/Auth0Options.html | 14 + docs/interfaces/AuthorizeUrlOptions.html | 510 +-- docs/interfaces/ClearSessionOptions.html | 441 +-- docs/interfaces/ClearSessionParameters.html | 487 +-- docs/interfaces/CreateUserOptions.html | 907 +---- .../ExchangeNativeSocialOptions.html | 636 +--- docs/interfaces/ExchangeOptions.html | 516 +-- docs/interfaces/GetUserOptions.html | 378 +- .../LocalAuthenticationOptions.html | 818 +---- docs/interfaces/LoginWithEmailOptions.html | 558 +-- docs/interfaces/LoginWithOOBOptions.html | 515 +-- docs/interfaces/LoginWithOTPOptions.html | 509 +-- .../LoginWithRecoveryCodeOptions.html | 452 +-- docs/interfaces/LoginWithSMSOptions.html | 560 +-- docs/interfaces/LogoutUrlOptions.html | 516 +-- .../MultifactorChallengeOptions.html | 518 +-- docs/interfaces/PasswordRealmOptions.html | 624 +--- .../PasswordlessWithEmailOptions.html | 504 +-- .../PasswordlessWithSMSOptions.html | 507 +-- docs/interfaces/PatchUserOptions.html | 430 +-- docs/interfaces/RefreshTokenOptions.html | 450 +-- docs/interfaces/ResetPasswordOptions.html | 447 +-- docs/interfaces/RevokeOptions.html | 393 +- .../Types.Auth0ContextInterface.html | 2731 +------------- docs/interfaces/Types.AuthState.html | 556 +-- docs/interfaces/UserInfoOptions.html | 368 +- docs/interfaces/WebAuthorizeOptions.html | 721 +--- docs/interfaces/WebAuthorizeParameters.html | 935 +---- docs/modules.html | 1486 +------- docs/modules/Types.html | 564 +-- docs/types/Credentials.html | 670 +--- .../MultifactorChallengeOOBResponse.html | 243 +- ...factorChallengeOOBWithBindingResponse.html | 247 +- .../MultifactorChallengeOTPResponse.html | 362 +- docs/types/MultifactorChallengeResponse.html | 245 +- docs/types/Types.Auth0Response.html | 577 +-- docs/types/Types.Telemetry.html | 457 +-- docs/types/User.html | 1367 +------ package-lock.json | 4 +- package.json | 2 +- 63 files changed, 2676 insertions(+), 38030 deletions(-) create mode 100644 docs/interfaces/Auth0Options.html diff --git a/.version b/.version index 7422eeba..adaf2bf4 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v4.5.0 \ No newline at end of file +v4.6.0 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index db95e81c..b5e43f52 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Change Log +## [v4.6.0](https://github.com/auth0/react-native-auth0/tree/v4.6.0) (2025-05-02) +[Full Changelog](https://github.com/auth0/react-native-auth0/compare/v4.5.0...v4.6.0) + +**Added** +- feat: Add support for custom headers [\#1155](https://github.com/auth0/react-native-auth0/pull/1155) ([subhankarmaiti](https://github.com/subhankarmaiti)) + +**Fixed** +- fix: Update prepare script to clean up package.json files [\#1157](https://github.com/auth0/react-native-auth0/pull/1157) ([subhankarmaiti](https://github.com/subhankarmaiti)) + ## [v4.5.0](https://github.com/auth0/react-native-auth0/tree/v4.5.0) (2025-04-17) [Full Changelog](https://github.com/auth0/react-native-auth0/compare/v4.4.0...v4.5.0) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 9b539efa..715d5f90 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1,2 +1 @@ -window.hierarchyData = - 'eJyNj8FqwzAQRP9lzkrqCMs2uiWlh57bW/BB2BssIktFWkNL8L8XN9i4pSE5LezO8N5eEEPgBH3MKyVkUdYCkU6OGrbBJ+gLZKam4U1P0Hi3PYWBX2IMEQJn61vonawEhuig0TiTEqWndW7bce8grjdocGo3U3FzXYwCsihXjINJdB/w9UFpu0TvMASazro2koc+ykzVE7TMV9D9wF32HDzTJ796pngyDS0CUhWzgJ2Ps8O/zZs+S336O6/UH4U3Nvw49if9AOr3+2Vej+P4Dc50qC0='; +window.hierarchyData = "eJyNj8FqwzAQRP9lzkraCNexdGtLDz23N+ODsDdYRJaKtIaW4H8vrrFxQkNyWtid4b09IYbACbrMVCbkXlUCkQ6OarbBJ+gTpFTj8KYjaHzajkLPbzGGCIGj9Q30ThYCfXTQqJ1JidLDOrdtuXMQ0w0anJrNWNxMi0FA7teMF5PoNuDni9J2id5gCNStdU0kD11KqaoRWuQr6HPP7eNr8Ezf/O6Z4sHUtAjIp3wWsPNxdvi3edVnqY9/Zyq7UPhgw/dj/9J3oM7fL/JqGIZf7LeoRQ==" \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 46cbe9e9..08546cc8 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,34 +1,33 @@ :root { - --light-hl-0: #000000; - --dark-hl-0: #c8c8c8; - --light-hl-1: #000000; - --dark-hl-1: #d4d4d4; - --light-hl-2: #001080; - --dark-hl-2: #9cdcfe; - --light-hl-3: #a31515; - --dark-hl-3: #ce9178; - --light-hl-4: #0451a5; - --dark-hl-4: #9cdcfe; - --light-hl-5: #cd3131; - --dark-hl-5: #f44747; - --light-hl-6: #af00db; - --dark-hl-6: #c586c0; - --light-hl-7: #0000ff; - --dark-hl-7: #569cd6; - --light-hl-8: #0070c1; - --dark-hl-8: #4fc1ff; - --light-hl-9: #008000; - --dark-hl-9: #6a9955; - --light-hl-10: #795e26; - --dark-hl-10: #dcdcaa; - --light-hl-11: #267f99; - --dark-hl-11: #4ec9b0; - --light-code-background: #ffffff; - --dark-code-background: #1e1e1e; + --light-hl-0: #000000; + --dark-hl-0: #C8C8C8; + --light-hl-1: #000000; + --dark-hl-1: #D4D4D4; + --light-hl-2: #001080; + --dark-hl-2: #9CDCFE; + --light-hl-3: #A31515; + --dark-hl-3: #CE9178; + --light-hl-4: #0451A5; + --dark-hl-4: #9CDCFE; + --light-hl-5: #CD3131; + --dark-hl-5: #F44747; + --light-hl-6: #AF00DB; + --dark-hl-6: #C586C0; + --light-hl-7: #0000FF; + --dark-hl-7: #569CD6; + --light-hl-8: #0070C1; + --dark-hl-8: #4FC1FF; + --light-hl-9: #008000; + --dark-hl-9: #6A9955; + --light-hl-10: #795E26; + --dark-hl-10: #DCDCAA; + --light-hl-11: #267F99; + --dark-hl-11: #4EC9B0; + --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); @@ -42,11 +41,9 @@ --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); --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); @@ -60,78 +57,50 @@ --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); --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); - --hl-11: var(--light-hl-11); - --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); + --hl-11: var(--light-hl-11); + --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); - --hl-11: var(--dark-hl-11); - --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); + --hl-11: var(--dark-hl-11); + --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); -} -.hl-11 { - color: var(--hl-11); -} -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); } +.hl-11 { color: var(--hl-11); } +pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 20caa56f..58882d76 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/main.js b/docs/assets/main.js index 187af7cf..3effabb2 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,2529 +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 Je = Object.create; - var he = Object.defineProperty; - var Ke = Object.getOwnPropertyDescriptor; - var Ge = Object.getOwnPropertyNames; - var Xe = Object.getPrototypeOf, - Ye = Object.prototype.hasOwnProperty; - var Ze = (t, e) => () => ( - e || t((e = { exports: {} }).exports, e), e.exports - ); - var et = (t, e, n, r) => { - if ((e && typeof e == 'object') || typeof e == 'function') - for (let i of Ge(e)) - !Ye.call(t, i) && - i !== n && - he(t, i, { - get: () => e[i], - enumerable: !(r = Ke(e, i)) || r.enumerable, - }); - return t; - }; - var tt = (t, e, n) => ( - (n = t != null ? Je(Xe(t)) : {}), - et( - e || !t || !t.__esModule - ? he(n, 'default', { value: t, enumerable: !0 }) - : n, - t - ) - ); - var ye = Ze((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)$/, - M = 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 = M), - (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], M = 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(M, l.boost, function (ze, Ue) { - return ze + Ue; - }), - !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 (qe, We) { - return We.score - qe.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, - M; - 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), - (M = Math.round(C * 1e3) / 1e3), - l.insert(T, M); - } - 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); - } - switch (s.type) { - case t.QueryLexer.TERM: - return t.QueryParser.parseTerm; - default: - 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 O, - G = { - getItem() { - return null; - }, - setItem() {}, - }, - K; - try { - (K = localStorage), (O = K); - } catch { - (K = G), (O = G); - } - var S = { - getItem: (t) => O.getItem(t), - setItem: (t, e) => O.setItem(t, e), - disableWritingLocalStorage() { - O = G; - }, - disable() { - localStorage.clear(), (O = G); - }, - enable() { - O = 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 Y(t, e) { - pe.push({ selector: e, constructor: t }); - } - var X = 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 && !nt(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 nt(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 = tt(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 Z = 'closing', - ae = 'tsd-overlay'; - function rt() { - let t = Math.abs(window.innerWidth - document.documentElement.clientWidth); - (document.body.style.overflow = 'hidden'), - (document.body.style.paddingRight = `${t}px`); - } - function it() { - document.body.style.removeProperty('overflow'), - document.body.style.removeProperty('padding-right'); - } - function xe(t, e) { - t.addEventListener('animationend', () => { - t.classList.contains(Z) && - (t.classList.remove(Z), - document.getElementById(ae)?.remove(), - t.close(), - it()); - }), - 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(), rt(); - } - function ve(t) { - if (!t.open) return; - document.getElementById(ae)?.classList.add(Z), t.classList.add(Z); - } - 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), - st({ trigger: t, searchEl: e, results: r, field: n, status: s }, o); - } - function st(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(() => { - ot(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 && !ct() && l.key === '/'; - (d || f) && (l.preventDefault(), a()); - }); - } - function ot(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 at = { - '&': '&', - '<': '<', - '>': '>', - "'": ''', - '"': '"', - }; - function te(t) { - return t.replace(/[&<>"'"]/g, (e) => at[e]); - } - function Pe(t, e) { - t.innerHTML = e ? `
${e}
` : ''; - } - var lt = [ - 'button', - 'checkbox', - 'file', - 'hidden', - 'image', - 'radio', - 'range', - 'reset', - 'submit', - ]; - function ct() { - let t = document.activeElement; - return t - ? t.isContentEditable || - t.tagName === 'TEXTAREA' || - t.tagName === 'SEARCH' - ? !0 - : t.tagName === 'INPUT' && !lt.includes(t.type) - : !1; - } - var D = 'mousedown', - Oe = 'mousemove', - $ = 'mouseup', - ne = { x: 0, y: 0 }, - Qe = !1, - ce = !1, - ut = !1, - F = !1, - Me = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( - navigator.userAgent - ); - document.documentElement.classList.add(Me ? 'is-mobile' : 'not-mobile'); - Me && - 'ontouchstart' in document.documentElement && - ((ut = !0), (D = 'touchstart'), (Oe = '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(Oe, (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 Fe() { - 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) Ne(n, t, []); - window.app.createComponents(t), - window.app.showPage(), - window.app.ensureActivePageVisible(); - } - function Ne(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) Ne(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(document.createElement('span')).textContent = t.text; - } else { - let r = e.appendChild(document.createElement('span')), - i = window.translations.folder.replaceAll('"', '"'); - (r.innerHTML = ``), - (r.appendChild(document.createElement('span')).textContent = t.text); - } - } - var oe = document.documentElement.dataset.base; - oe.endsWith('/') || (oe += '/'); - function Ve() { - document.querySelector('.tsd-full-hierarchy') - ? dt() - : document.querySelector('.tsd-hierarchy') && ht(); - } - function dt() { - 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 = mt(), - a = s.querySelector('ul'); - s.insertBefore(o, a), - (o.dataset.dropdown = String(!!a)), - a || s.appendChild(i.cloneNode(!0)); - } - } - } - function ht() { - 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'), - pt(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 pt(t, e, n) { - let r = e.roots.filter((i) => ft(e, i, n)); - for (let i of r) t.appendChild($e(e, i, n)); - } - function $e(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 = $e(t, a, n, r); - c && o.appendChild(c); - } - } - return r.delete(e), s; - } - function ft(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 mt() { - 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 - ); - } - Y(re, 'a[data-toggle]'); - Y(ie, '.tsd-accordion'); - Y(ee, '.tsd-filter-item input[type=checkbox]'); - var je = document.getElementById('tsd-theme'); - je && He(je); - var gt = new X(); - Object.defineProperty(window, 'app', { value: gt }); - _e(); - Fe(); - Ve(); - '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 Je=Object.create;var he=Object.defineProperty;var Ke=Object.getOwnPropertyDescriptor;var Ge=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var Ze=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var et=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ge(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ke(e,i))||r.enumerable});return t};var tt=(t,e,n)=>(n=t!=null?Je(Xe(t)):{},et(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=Ze((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)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default: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 O,G={getItem(){return null},setItem(){}},K;try{K=localStorage,O=K}catch{K=G,O=G}var S={getItem:t=>O.getItem(t),setItem:(t,e)=>O.setItem(t,e),disableWritingLocalStorage(){O=G},disable(){localStorage.clear(),O=G},enable(){O=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 Y(t,e){pe.push({selector:e,constructor:t})}var X=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&&!nt(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 nt(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=tt(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 Z="closing",ae="tsd-overlay";function rt(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function it(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Z)&&(t.classList.remove(Z),document.getElementById(ae)?.remove(),t.close(),it())}),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(),rt()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Z),t.classList.add(Z)}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),st({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function st(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(()=>{ot(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&&!ct()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function ot(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;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:${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 at={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>at[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var lt=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ct(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!lt.includes(t.type):!1}var D="mousedown",Oe="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,ut=!1,F=!1,Me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Me?"is-mobile":"not-mobile");Me&&"ontouchstart"in document.documentElement&&(ut=!0,D="touchstart",Oe="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(Oe,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 Fe(){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)Ne(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ne(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)Ne(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(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(document.createElement("span")).textContent=t.text}}var oe=document.documentElement.dataset.base;oe.endsWith("/")||(oe+="/");function Ve(){document.querySelector(".tsd-full-hierarchy")?dt():document.querySelector(".tsd-hierarchy")&&ht()}function dt(){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=mt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function ht(){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"),pt(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 pt(t,e,n){let r=e.roots.filter(i=>ft(e,i,n));for(let i of r)t.appendChild($e(e,i,n))}function $e(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=$e(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function ft(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 mt(){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}Y(re,"a[data-toggle]");Y(ie,".tsd-accordion");Y(ee,".tsd-filter-item input[type=checkbox]");var je=document.getElementById("tsd-theme");je&&He(je);var gt=new X;Object.defineProperty(window,"app",{value:gt});_e();Fe();Ve();"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 4a9dd4fa..c0b57f24 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1,2 +1 @@ -window.navigationData = - 'eJydl8tu2zAQRf9Fa6N5oElT72ojKAIktWE5zSLIYiKNLCIUaZAjJ27Rfy8o2NbD0pDOMpoz5yrUkJKf/0aEHxSNo+V2jTYaRWugPBpHhU5Lifasuvwlp0JGo+hNqDQaX46iJBcyNaii8fNB8KOkvO5PJFh76He1tuTi8ubf6NA7AYu3xmgzJDgAnGVqMEVFAqR9AAUrHNQdk5z30aKxQ6qqyHU/4Su3NLsyZ3D186lW7s87RWgySLD2if2l5mof8Z1neHXdCYgJyCetGJ/ofIF2rZVtyMgZmje3Rzqu8+/fLq4uG74lSiyQzLbfdSj3e14apnudgHTZ7rEnQEKre9ygrMWoysKeDXHthBveHJMBwtU2QL5Hh/0xZGDEb4Hv7pEaLSWauUGLinaGrcRuUlDTcGaKGZSSjmd2V+CmdSkK1CUNbedG1Tfz2og/+GjkbO1u2fYOZw/HDehUIpgYrRVacdoeLlQ7BwMFUuvIGDDXKCs3CITunGHvuEtxytuPJAe1wl9AYoOxTgSwq8zwITEh6gDdTyTfKrQRTtazFznxMM6HrIR6EpTfFiDYFe4lg9Sz2SRIXHNh2uU8THvggrQLTPQGzXaqU3YsuIagoPghDvLXnEerS/KcRV2IEz6UkkQGCWkzzUFK9GwThudi5mDtuzapRGuD5pBrOCXIs/zDeEjIAkEWIfomyIspyX1nSxfihAvMDNp8qd+QPVZ6OF5rkfb/HO89BnnxRr+xA9giOJVboTuVaU7WYTjd7vu4esdzyh4uVOt5Y/ejnjf2/udF98O1UfJ9/PZu+dlk6PPag38yzW3OiVCpUKsTg3s6P3UPy/lJwTX+mbRTokJz3LB3fe6ar6/6pTQ3eiPSpiArVVKN91kLaNuuvzZEpcUK7XPsa0ftL/8BSB6new=='; +window.navigationData = "eJydl11P2zAUhv9LrqvxocFY79YKTUiwVk0ZF4iLQ3LSWDh2ZZ8Uumn/fXLUNh9Njl0uiZ/zvMY5dtznvxHhB0XjaLldo41G0Rooj8ZRodNSoj2rHn/JqZDRKHoTKo3Gl6MoyYVMDapo/HwQ/Cgpr+sTCdYe6t1YW3JxefNvdKidgMVbY7QZEhwAzjI1mKIiAdI+gIIVDuqOSc77aNHYIVU1yFU/4Su3NLthzuDGz6dauT/vFKHJIMHaJ/aPmqt9xHfe4dV1JyAmIJ+0Ynyi8wXatVa2ISNnaE5uj3Rc59+/XVxdNnxLlFggmW2/6zDc73lpmO51AtJlu9eeAAmt7nGDshajKgt7NsS1E254c0wGCFfbAPkeHfbHkIERvwW+u1dqtJRo5gYtKtoZthK7SUFFw5kpZlBKOu7Z3QDXrUtRoC5paDs3Rr09P1u7udrermwCvpbURvzBRyN9vg7HaacSwcRordCK0/Zwodo5GCiQWmfPgLlGWblBIHQHFjvjLsUpbz+SHNQKfwGJDcY6EcCuMsOHxISoA3Q/kXyr0EY4Wc+m5sTDOB+yEupJUH5bgGBXuJcMUs9mkyBxzYVpl/Mw7YEL0i4w0Rs026lO2bbgCoKC4oc4yF9zHq0uyXMWdSFO+FBKEhkkpM00BynRs00YnouZg7Xv2qQSrQ3qQ67glCDP8g/jISELBFmE6JsgL6Yk950tXYgTLjAzaPOlfkP2WOnheK1F2v9zvPcY5MUb/cY2YIvgVG6F7lSmOVmH4XS7i3b1jeeUPVyo1vPF7kc9X+z975TuDbgx5LtF92752WTonu7BP5nmNudEqFSo1YnBPZWfmsNyflJwjX8m7ZSo0BzX7F2fe+arq67Kc6M3Im0KslIlVXuftYC27fprQ1RarNA+x37sqPzlP/gAwEA=" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 5b8c90d0..50b707be 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1,2 +1 @@ -window.searchData = - 'eJy1XV2P4zay/S/u195ZFfU9b5tg9yLAZjPYmWQfBsFCbbO7ldiWIck9mQ3y3y9ISXaRLFIl2XmaQZusKpKHZLFOkfp90zZfus37z79vfq2Pu8178bg5Vge5eb/59PUku83j5tzuN+83h2Z33svur/qv7177w37zuNnuq66T3eb9ZvPH4yQBRHGR8bdz/3oRMZYeRaifCDmPm1PVymN/MQAJjkRykbzd1/LYf7ebk/4wFKx3YTW6gk/XrjlU9XFW06XYAj0iSq69VZ3716at/yd/bPez2i6Fz+1MFwZ1bltZ9fLHTrbzPamLnoeia/XJ37av1fFFzmpDBW/V9a+qr9/kx2ZbV/P9OlU66krdVGmtDfvmpT7+p+5f/36o6nntuviXun+VY/Gb9f7wwzd8rU3zdBednz4s0Nmf7qHz33LbvMn267fNbh5cF+XtWGs71LrZio/ff+Qr7w7dbTqbc89ZKoaSt60Th/O+r5+rbd+0375W+73kzGFUaYsqrbXhVHXdl6bd7WXX8acUrnWPmWVbwRly24bbRn6S9m9Z7Q9s3e1Yeq3WVj63snv91Pwq5/fCsXA/Fl6vs5P9h7EBDKWd7E/X0uu1vjW/zqP7UmytHrWVfnd8bmY1qYL1UHCJD4McsW+qTv69bRvfLn/5fZlLlsLVX9w2x65vz2qys5Q8mBVCDbta7/HQ+q8n33hZSseSi7Whvvy2lTvlUlb77vvqWL14XSe34LLeNR21vaxaJHGZzgddfWtUD/UB0UaPXS+yX2/Vi+z/DJteq+6nal/v1hv2WnVvSsKfYV1Xvcn1lqnad7IKg1qdAHym6N9ugO6L7AMHjKt0BQfG8WIw1bs39ttXnjZddIU+3G3/kU+BM+746w1ddznlMTQ84MKhBk1G+1aa6riVe37LHoYKX+RTNVS4Rbdapj7Krqsbn5Nhqlblu0v5hZrTzIhURN82x17+1n937GX7XG2vnV5Pf8F7s1P8hnCGO84LVLIHnm7knEmuq73KtiW+90ojQ+f99TavCwisawI+ra+2mHeKX2kgOtqvN5B15F9n4AfycLTa1KWnp3VGk8GL1TYvDGqsMxkfe1dbyjsHsw2kd64l1i3ZypaZ5nPfF1m3zIlfbqC98y42jrcVLzJMGsfWJRZNNa+m9N3uL3X3l/r4Ktu6l7sbTfOcfZbYuOgEtMi40CFoiYXLj0KLzKy7fzbVrj6+rDKu7vaX2n/aMNNRqCVmLo1MLTBNxaD+TYXmltmnxCwM2rGN7ORxpx3I1dubkqB9x3tvaUrw96HQ9lIrV4a8Fxn88fuPN/Vkd+ju3Y9nfOJeYo9z/r597trHuo991c90li5yw/GNsUddVRD7Et3IwfDb1k2kll4rV6ieH2yklckX2wpFVOaQCvN8/m/ZnZpjdx1MFc01QDaVuGEsX2W1w7GwsI6Ha/HZyXQx36P5lw65XjNqx7I362x+5WrUJW/W1/VVf2Z37qX0zXrVYsHVOpZdo9OG7Se5lwfZt19J3Zdfb1l6jm8M2Q9DsVCTrqZ6NOl/GKrGcjfpepOtcRAJqLsWXarxGnb8Z7Ot9mpMlYO7rfq6Of5Tvslr9Egez4fur75i4Xyo6260k2/1FsX+l4h/GCpvcWW6wd7GkDZ1fdugTYRjyaXKPfR/kdWvi7SPFVbrDo76x76tevnydd6iqeSysf/hyxHtnTzh48g3Y1V2wy9tmbNHhXO+qRs1Peptd4N1KqTzhAXdYut1nD5Wz1Vb/1TLL8rra5v9XrYf1JHq2I+Vv+6lZTarDnfsqnPfHKq+3q5W8oBF0L3CayVp3/bcKiGjT7zeyFHO9iLnT7C065vDLRaO9e9u2XPTHj6+SnlD9ykR3Sji/vad9/uP21aiE/5yA8/7fTfJuLuFx+a4fhY+jLXvbpWKhH97p/mhZP35c0Rp+ccdRlvJ+XNH/FS9yBvnjBLxp82ZU3NSnXCDdRcBd7INpQ7s5HN13l+7bmK5x78H9yZu3hWWxcq3mowKMEBhJUHeZEb6dj6xymzQtfzhUn6V5i+eZAdD3Rwr5Opwsv3cDBtDw1SE3QYEp0/1QTbn3pPkh368C7AcgbxsPmzjolQ+R52TxxeMG9J67UDhdPfih5OauyRbQhQLO5FmsH5Xt3Lb/9jWS2Q/TPXOuh7dtZT9fjpDhy0+4Z7m2TFUDOZQLjCk8wVmvRZMNdaoxqP9LSI7A6NNFOOP9uCqfty+ygPZSJ/w0cftpop0W6kW+MO1/5Qv1fbrt9V+/1Rtf8V3BjgGnTu51wK2o4DQVYKwYb5B+FC11UH2eIX0WHYtyR+KZ7mT6nxJkncB4Q+44nxzUSO8U68/t8dPDWMEbFOGqn3D7XvSGKP7Lze/QjPALrQA/83xKLe9J52AFvxgVPI00rHbFxn15ax5dIeT09hqn6tDvf/6XyNaOq/crHWjCS/1mzwutcCodKMBB9lXu6qvFqhHVW5UvrDd92nxsd7+ulTxtcqNyk+B3ASP8tlkBL7yWnkmSxp+rXGjauUvL+x0VGW5crx8UsmmgYU0UJy/pFbnXS2PdF7ynIIHVJlueahFPg9u29A+5Kw1U837mXJ++kVue28OzLxFg4Bw9suNhvlc7kXGBd3vFQaqKfGhbZ7r/TrbVP3Tpf4tZlHzizGnVrgmdPYMJfAhmCpjW7nu5Efq5Zz6mOrfZFs/13TSBqkbVViqGI/h/w0XfwJDaJbgj2BN7nWEtIfAyw+WeXQbCLIq0B5/6SWrvJ+H5qt6MMXsRzFsRm4GUkOi9Ke6pxeNOeOG6v1Y/V5G7WS3beuT78wxZ5RZ/X5GmaT/P8ZD9DoLzRyA56use5kr36r9WRf80Ozr7dc1Zl5lnCYZ9zJvavFq5E0C7o297vzUr7UJ1b2XOattuYMh5vKJ3z8JrpxEwfu4xn7R804xbf9CvyJgQNC7WKTcG+4IaA+HPBap9x4FAurDh4A59STMfvjhGw7IrsX4EHuqjyp71pd67ZP9MNbjjTSy3xdbea68hxyvDYfnKnywWWBA0zwt7oOmebqh/fRIf/rAGulLsTsvJpbgBUsJsvymMbYMWDDGswYMNzT5ukM3OsNqybHF9yE5g0yU5482q7N9Ghb0OtUo73kxfB903izWHVCmaeQQffz+I2dkrsXuPP0swQumH7J87T5uK+f18rzi02tzlP86H57os7pXv653nOrdbMb8Xm4bwNzJSdUWvIZHzcLYMsosiPvYj0bOSZ1/PdIxeA0FSeueJx+5yifaka97YhvXqMbjSd2tCwxtoPiq+EnT0oM9p+fBkBEY/lD7fCCcyvmCwbPGXSQEI8ErTAvthLNWzW6EPIMwej5QD/4F4BMqvww/mj1fp0Nj5zTVp7si2LCl57t5i8LHvDXGqGuk62wZa95kSggjYb/EX/rPwofrpyxGx81+w5xNHPdhuVFcjDi+xBKEzHoUxnswDGTgcvdxWb2S531W0vgVSQB+E2bzAJaY0Pre3PHrD7+rs0S512n1Kw97rUuUhzIR/PpnkxFmTDBxPj58F8S4WeZWvo2UF2LcHCNX5A/RSmfThwKqcTfipzQCPUkUW5IHHH6uwyec96ou1YKlU8ZrQXjGhFWb3YyeVAn2s1vuXimIXtmcLESyAUs9N78FYY9tRrnZ0epll2APowL3xLAtlotebC/dph/Hd5MDrbKK8NvV+xpESXwIt8W2k27N+FyZTlwPtIgodr9cdJ9wXi461QLfVDgpSW21D7w05jXmUnnulbEFBu2l/FKRJLfXjEuVm5VzM/O9pizKzF9m2Md/UJfbllrXPXdaylstv2yxlDUm+mZN+PIAXXKBa7/b1cqSar9az8NVxgnLmO+E+SsFoZNH0KS5s8cyM8JbbcgQxma7zJT6+FYP1y8Z08m25lqZO5XmDTpUv/2NflIsZMmh+q0KvB22zIRjswIiU6V7GNC0L9Wx/l+1BiFW3XuYc03IXIyQa17mvfDhdcNDZoQ98YUG+C7iBQ0I3sWbNcB+KYl6pnJ49Qf9smDV3m5l15nuKS3uYSgaduWwdT7X5rdT3crub/YzU46+sWDlv/LO0FbvWG2rdze3i/T0PepYLj5DpzkjPMrCM4ChpXdS8j2a5tPuaW02xkkG5IdvPM/azZQOzgWm5uHlH52etMwIouLt9nz6sMSIa+kF5yCSe+MruYV6Q61b1i8LOmXVWBhfyxhkqz8t8pBb2dnL9kXGw/V3/znZn3TX9q87vD3Z0nGJ5fLN2IwtOxyGmZX703CNYheW/3YttVzPcG/0X5XzNN9VyVAkGGcOaXhRb+96AfJw+XmFZHXjNGi6LrHa8r1KVvYLv/y8XPKh3u32Mmj6UGS17ceQ7PVS7VuqjuS5O6kh6RQLaSvgUI1MHbOzC+m6aY7ZN1wdPTP3WYOyW/ks21bufrQZJEfLVHKWNQrrMy/6uVrCF/lCsrvzk1fu8NtymeeTWtp3jld9lTyWCLjTIflf5FNXB3aX6+/LZf+vOcoaf9/PFo4KsKRnV9n6AdoPbfNW48X5+XzUkZThCZXL7/yt/NQ2p+G5WY5IhZZTPxanW2DaSTbl3EldilA5/UQ14OfHTX3cyd8273+/PBf7fiPexe/KzePmuZb7nfqw9bSSbpvDQZn0uNk127P+789jsZ+kcqJU4aH0X6PN4+foMYV3Ivn558fPU139d/2HScT1L7oebB4/w2OSvYMYjIrgVASjotg8fhZUReFUFEbFePP4OSYsjZ16sVEv2Tx+Toh6iVMvMeqlm8fPKVEvdeqlRr1s8/g5I+plTr3MqJdvHj/nRL3cqZcb9YrN4+eCqFc49QqjXrl5/FwS9UqnXmmOvAICUJgBFzRgoUbDBqi6BG5M4ICCAwiqrgsdMLEDChJAoQdc+ICJH1CwAApB4EIITAyBggZQKAIXRmDiCBQ8gEISuFACE0ugIAIUmsCFE5h4AgUTKB6T6J1IrcoupsAEFSisQEkuDC6wwESWUGARFLKEiyxhIksosAgKWcJFlrCWJL0mUcgSxKJkIksosIj4MRHv8iw3K7vQEia0hEKLSMjV0MWWMLElFFxESlZ2wSVMcAmFF5GRlV10CRNdQgFG5GRlF17ChJdQgBEFWdmFlzDhJRRgBLVqCRddwkRXrAATR5Ti2IVXbMIrVoiJKXjFLrxiE16xQkxMwSt24RVbm57e9WLSaGLjM+EVK8DEJLxiF16xCa9YASYm4RW78IpNeMUKMDEJr9iFV2zCK1aAianFK3bRFZvoigt/k110xSa6YgWYmNpLYxddsYmuRKOLQmbigisxwZUovCTUupe44EpMcCUKLwkFzMQFV2KCK1FwSShgJi62Esur0m4VtaMmhGNlQitRYElIn8xFVmIiK8m8sExcZCUmspLcu+olLrQSE1pJ4cV04kIrMaGVKLQktNkuthITW2nkXW9TF1ypCa4UvOtt6qIrNdGVanSRbU5deKUmvNLY6wukLr5SE1+pxhe1CKQuvlLLc9f4ouZxSjjvJr5ShZiEmsepC6/UhFeqAJNS8zh10ZWa6EoVXlKg/IjURVdqoitVeEmpiZy64EpNcGWRF5mZC67MBFcGXnxkLrgyE1yZ8DY5c8GVmeDKFFxSav3JXGxlJrYyBZeUWn8yF1uZia1MHwspjz5zsZVZJ0MFl5Q8GxKHQxNbmcYWNR8yF1uZia1MY4uaD5kLrcyEVqahRc2HzIVWZkIrV2DJqPmQu8jKTWTlCisZCY7cRVZuIitXWMmo+ZC7wMpNYOUKKxkFrNwFVm4CK1dYyShg5S6wchNYucJKRgErd4GVm8DKdcyBAlbuAiu3wg4KKxkZeCAiDyawcoWVjAJW7gIrN4GVK6xkFLByF1i5CaxCYSWngFW4wCpMYBUKKjnlMBUurgoTV4WCSk7hqnBxVZi4KhRUcgpXhYurwsRVoaCSU7gqXFwVJq4KBZWcwlXh4qowcVUoqOQUrgoXV4WJq0LHsyhcFS6uCiukpaCSk0EtIqpl4qpQUMkpXBUurgoTV6WCSkHhqnRxVZq4KhVUCgpXpYur0sRVKbxBhNIFVmkCq4x9odjSBVZpAqtMvDGE0kVWaSKrTL1n09KFVmlCq8y8p/HSxVZpYqtUcCmoeVi62CpNbJWFv69dcJVWzLT0BmxKIm5qB041vMgoZESFTq3YaaQRRioffrPrW/HTSOGmIIORERFBjawQaqSgU5C+3vCbXd8Ko0YKPQUZk4yIQGpkRVIjhZ+CPMcMv9n1rWhqpCBU0JHJiAioRlZENVIwKumwNxFTjaygaqSAVNKMSUSEVSMrrhrpcD0Z/Y6IwGpkQU/H4UsSelTU3gnbKyiVCTVpgIzcW9DT4fgyfYyLdyKx6xPYs8P3OiRfkrFwKoBvR/B1VL4koUfF8O0gvg7MlzT0qDi+HcjXwXnalwUqlm8H83WAvqShS8Xz7YD+ENGPyMUWqJi+HdQfovoRjV4qrm8F9kEMnBHJ+wER3Acrug86Yg8RCWAiwA9WhB901B6i5DHO3qV5Zgmg+CMLgTpyD1H6GKfvIEktAQQGrVA/6Og9RCSGiWA/WNF+0AF8iEgQE/F+sAL+oGP4EFFOFRAhf7Bi/qDD+BBRjhUQUX+wwv6gI/kAETkLiMg/WKF/0OF8z/ZHRP/BCv+DjugDTT4SBABYDADEA3dJLsEECQAWCwA6sg9A+ktAMAFgUQGgo/tAM5EEGQAWGwA6wA80G0nwAWARAqBj/EAzkgQlABYnADrMDzQrSbACYNECoEP9ACSCCWYALGoA4gGBJIIJcgAsdgB0xB9IfhIIggAshgB01B9IjhIIkgAslgB05B9InhIIogAspgCSgUAn11CCLACLLYAkDqyhBGMAFmUASRJYAgjaACzeADQX4HEjCOoALO4AkiywiBP0AVj8AWhKAASdDEBA0KIQQLMCIMgpSJAIYLEIkAwQzEhyniASwGISIB0wSM5BgksAi0yAdMAgOQcJOgEsPgHS0D5MUApgcQowkAqeHiBoBbB4BdBcAZAcMhDUAljcAmi+AGJyFSDoBbD4BdCcgbcBBAYtkgE0cQAkFw0EzwAW0QCaOwCSjwaCagCLa4C0DA0hgUGLcIAsCiwDBOcAFukAmkeAmDzDA8E7gEU8QCYC6wDBPYBFPkA25BOR6wDBP4BFQIAmFWhvmKAgwOIgQPMKnsMkQUOAxUOA5hYgJpchgooAi4uAbIAgnZtEQNDiIyAbIEiuQgQlARYnAZpngJg+kRG8BFjEBORRYBIS5ARY7ATkAwTJVYTgJ8AiKECTDpDQRzKCpACLpQDNPHi2QoKoAIupgHzIaqMxRLAVYNEVoCkIILMHgGAswKIsQNMQ3h4gQGjxFpDngVWA4C7AIi9AExLeLiBgaDEYoFkJIJMggCAxwGIxoIgCKynBZIBFZUABgYM9QWeAxWdAMcCQXMcISgMsTgOK0KmY4DXAIjagSAKBAYLcAIvdgGKAIbmUEQQHWAwHFFngVEawHGDRHKCpC09wiGA6wKI6oBhQSK6lBNsBFt0BmsLwpWsSILQoDyijwBAStAdYvAdoLgPIVA0gqA+wuA/QdIYntkiwH2DRH1AGVkKCAQGLAoFyWAlJl5YgQcBiQUATG54BIHgQsIgQKIeFkNxKCCoELC4ENL8BZNoJEHQIWHwIaIoDUtKfJBgRsCgR0CyHJzBPkCJgsSJC0xxAZq8IghYRFi0iNM0BZCqIIGgRYdEiYqBFyOiqIHgRYfEiQvMcQKaTCIIXERYvIjTRAWRKiSCIEWERIyIacsypBUQQxIiwiBERZf5dSBDMiLCYETEwI+QEFgQ1IixqREQDAKkFRBDUiLCoEaG5DiDzWwTBjQiLGxHDhQYyx0UQ5IiwyBExXGog81wEQY4IixwRw8WGjM5dJwBokSMCApuwIOgRYdEjQvMdNLMnCH5EWPyIGG45kPk2guBHhMWPiPGmAzmDCX5EWPyIGG47kHk3guBHhMWPiIEfIXNvBEGPCIseEeDfggXBjgj72oMIbMGCuvpg330Y2BEyAUhQ1x+c+w8DAskZSF6BsBA4kCNkIpCgbkHY1yAGboRMBhLURQj7JsTAjdDnQUFdhrBvQwzkCJlRJKj7EPaFCE120KmMgroSYd+JGMgRMitJULci7GsRmusAMjNJUDcjLG5EaK6D9qEEwY0IixsRAzdCZjcJghsRFjciBm6EzHASBDUiLGpEDNQImeUkCGpEWNSIGKgRMtNJENSIsKgRMVAjZLaTIKgRYVEjYqBGyIwnQVAjwqJGhKY6aIZZENSIsKgRoakOmmEWBDUiLGpEDNQIfRYXBDciLG5EDNwImbYlCG5EWNyIGLgRmqEWBDkiLHJEDOQImfslCHJEWOSIGMgRMv9LENyIsLgRMXAjZE6TIKgRYVEjIhlOIeQMJKgRYVEjYqBGCnIGEsyIsJgRMTAjZHaRIJgRYTEjYmBGCnIGEsyIsJgRMTAjZHqRIIgRYREjYiBGCnIGEsTI9Dd9M/tNtr3cfTfc0P78eWO8svX75r/j3W3l4Wht6hq3cmLe//7HH9fb2u9//wNd2Fa/KY30c4pI6PWhyN83yrdnCh1eqUFyckByRMGTc3lYEQmKkqsglUahqyoucPhPOv0lLcf/FNHwH3Ww4GntXw2NSN9QpYzZgiL1VKf8rb+8BIclx/lVdJzzZZ4ujxUgKws8UAm3g/vXqL08inSVliIoZfzWOh/JRfZBivoxTpbKHL4dg+ThzlMRfK48/Y6eMQoIUINdj5t4oTz9guFVJJLIb+gkqJleLr7KK9BwqLzNRSK/1P3r+PoSanSBGl2uEDh+tfqov0Le6a+QG/JL1AUrDG6aJ6NDIyQOVohTH9VD4tCcTsRycdOnHsZPLiDBAgnmz5uLYPNbc0guAkCyEFJKbncw8JRggDLXdPSxFTQL8cAoEmlYcnP+Sju+fYmWHtSFKRuZzaHq6y2WgzecggeZp6qTsm0bY2EVAm9cPDn4M6WoswReAplLNHqTDe+mhlG8XjI+FI4X5gwvzDw0DLK+yCd7s4xREwdZj5uEhwbrQUC81Bd4qR/3dXXIZondy6rd4idR0djiPTMbreVtxFrs5fV01AFIZDyJ5A01FkltAnjDi3iLABZJO3glnsARt+3Tp/xQV6KeHFeBjGmjPU0AmzS4isrDSyaxvO0EP4aNmou9Rxj9OcX5jC4iswOaY9e3Z/XWkdEH2AEfHdJJdMnEQCurXp4707lDk4oJ+osYAkgl9iaA2Zv0BFJRWXTmYBs3yTpUx+rFbCteJMW4gpRMJJ1b9VbW6HIbmwEys+At4sP3GgwhqN8K3uZufvQBzWW8okXpBEPeQr6Tz9V5b7SvQJtdydvsdrLbtvXJniAqgRZtB7yleyff6q28jisWmKEZl/PG0Rb3PH6SwbQTdyHz9DQIbr4cTchlSFTOm6dIkvKvnurmIPu23hqzI0NOcM4c2+ZQ1eaGgvYTlgjH1y+x2wGXE/OEunw6Opfjf1T4la3o+hwkdk+MhZCHR3l8M/oObQI50x7noyY4joEXKuYRyvEFE9STyeiHMLcj+Vbtz/pofGr29farieUSY5mHwOkEZnQaOrUvEuI7xqG1gDfDKIHEFqSu2qA9nomQUTYpD/eg4Np6eT0e72gJ3tF4kqYFynWuBfZlmAft4ZXh/+pqeBpjPx14awF+sBjPT9zGmLcfom8oI5twcCyaXLWM5wc8N+2he5XS3KmRaQVvu3g+7/fdtpVmODRHc7XgGTQ9wIx7CnsjMa/TX2TvO2+g+TSA9HGT8taPF9nbXmGMOp+5yI5SqBkEAiOVKU49Ku0CFXsQwBtD9Dw17n18PmPGDF+r7q3a1zvfEKC9fjpbpLzWvspqZ52eUoRW5nHHCmMCXgjjaXMueMv35ZsUeP3CiAXeXmJ9qgdvmxixEVNat28qFQAxtk40lFOMPuP1+y+duZenqIXMpWb60BhuGfZRIp4l+p3zmUA3ZmFy3oJBiCVnKD67MtciQnTXq2X8xeiNDG/0vD1vevMdT1cMFmYkad+81EcyRI0mKg93piiqB/EBHZiB34tUKySNHA7eto4Fkcbh4WVGoa4yzQC3EULhbTBYFGkePm8xV8yLTF9cG7D/cINMyuAY90G6EI1WwNzYHBfipjt0pHlYZMpGeHPu7TXa2EGWySENwzhkkn/TF9bw+oo32og3Ra6fHkbzDOMOpkNrwZsfh+fK3SFx1BemY5y6yDf+Z4zaAvPYiT9PgRdD3H5mHOVw/RDNJRpu0i3Y8tUim+aJIn0B7wKCyXV45A9BEU2D0Kpw7wgmyChVFIDx+GZMoFCy+xNte4ltXz8MpPA8wsJ5sLGxl6FVNZ9i3DDCWjBjZdfvl6C5iE/ZkE8CeYvX+A1EvETgjmRuU8fmaAjBRwSm19wYgUSc4JIxBTRPLreHDz3MM535NUaMMAwC5r5oewACj1XKQ6naTwNBdNRE5vqrBHqO59i94wHoVL1IN16AmlnwdpmJvTcdJuwtwBTJYBLHk8S97DrSlzWSX3iuCCmTXO7wQOfrDLbdHWMFXSuRMhYnSKg7m0tEO9kWBlXBA6QhizQQe1PMoP2p6revTnQGtZQZYrvIIQ3DEGIGtIxPRGHI4EZm0w6RXxZ0ZrNfiY9C4dHByzszCejyASg8NY1DwkT/M9OATs1JLULGwRJN9ZJplvvFKJx6h5dr5rHy8nUoLAfnSDLTh9B3g7Ak7MklvOF0pxdOEwImbeo96eFopXo0gids+kBwbQwgtiua4MtMgzE+OoyXPNz5zDOe+ZFW3P+446a9ZDpplOMhRgDX4qsWcmXAqzVzL21lJ3tyI8S7yWhxyoOiIZM0FK/XTJp6cpLtpKACL4cRd7j6c3vsGxOXWBDTAZwEWRgq8ebGPPK28q351WgZpowEb3kahJBdjpHITKMYpPmwjQeR6VZ21XPV1m+1/KK8yrbZ72Wrjlby2I8Rya/mSogPQQWvC7rqTfpC/ngf4o3K+EFkvAlhmEzJPZBMsYLsErm/sOlT2jlMtDpzMDt5NGckzlaFfEqDYiYqKGnadXRSShEymNExJWsuRJGgzk55s0mJ7Q6dbWCKQMDcL5xkUpwUr16MHUeECdu+6s8m3YOwzwwsdH3bmEwIJmiYHrD+5CPeXnAyAzMfuDs//SK3vbtXRbiPmOEMLMxJ14zwMs/M0uzOTwR5joHPdCB7uZcqFcegN3CgIeOtAPbhF4czmbcN+vogm3PvZJHg0St5KCL6Bu81TF/YHXs8x4BrCznoGaZqmQkdthDMgIhxnWPmxDkuMGoYDzjo46d4pmGWkJkqf+5kNXyFEwvCAU9mfOjcyb18qbZft2N+ieVvFNhXi6b4HtMZcnJM0WRLR5912tUEM6NGyRy+wooG1fCrF4khHRrDP+VtMOShLTIonWjavnnrn5JIneAi7G4xo7dKltFGTFzFo2H8lnbPlLtlzno8zyKecz+e8E1BBn3HzBqcPjCLd0Q0FDkPvV9kZURx8fLDvH1C3V7AyZZTAjdv0o/S9I0bCrd4egEzGRzL9F3PxNkezEsBlw8x4+XJWHp5HXj95jIWhA3isNg/P25O9Unu66PcvP/88x9//D9Hbc3f'; +window.searchData = "eJy1XV2T47it/S/u174TA7K+5i27dXMrVdnsVGY2eZjaSqltdreytuWS5O6dbO1/v0V92CAJUpDsfZqpNglA5CEI4kDUb6u6em9WH7/+tvqlPO5WH/FxdSwOavVx9eXbSTWrx9W53q8+rg7V7rxXzZ+6v354bQ/71eNquy+aRjWrj6vV74+jBMDsIuPP5/b1ImJoPYjQPzFyHlenolbH9mIAEbzGzUXydl+qY/vX3ZT0h75huQur6Tr4dO2qQ1EeJzVdms3Qg+vNdbSKc/ta1eV/1U/1flLbpfG5nhjCoM5trYpW/dSoenoku6bnvulSferX7WtxfFGT2kjDW3X9vWjLN/W52pbF9LiOnY5dp2bstNSGffVSHv9Vtq//eyjKae1d8/eyfVVD85v1/vjjd3KtVfV0F51fPs3Q2Z7uofMfalu9qfrb99VuGlwX5fXQa9v3utmKzz98litvDs1tOqtzK3EVfcvb/MThvG/L52LbVvX3r8V+ryRrmHTakk5LbTgVTfNe1bu9ahr5kqK97rGybCskU27bcNvMj9L+oYr9Qay7Hlov1Vqr51o1r1+qX9T0Xjg0bofGy3U2qv00PIBAaaPa07X1cq1v1S/T6L40W6pHb6V/PT5Xk5p0w7JvOCeGIYHYd0Wj/reuK98uf/l9XkgWwzVe3FbHpq3PerGLlDyYHUIPdrXeE6G1306++bKUDi1nayNj+X2tdjqkLPbND8WxePGGTm7DeaNrBmp7VdRE4jydD133rdE9NAbMM3rselHtcqteVPtH2PRaNP8s9uVuuWGvRfOmJfwR1jXFm1pume59J6soqPUJwGdK99sN0H1RbeCAcZWu4SA4XvSmevfGdvsq09Y1XaCPDtu/1FPgjDv8esPQXU55Ag0PtHHogUajfZ6mOG7VXv5kD32Hd/VU9B1u0a3d1GfVNGXlCzJM1bp9c2k/U3OcGJmK9ffVsVW/tn89tqp+LrbXQS/Hv9C92Wl+QzrDnecZKsUTzz/klEluqL3Itjmx90IjQ+f95TYvSwgsewR6Wl9ssewUv9BAcrRfbqDoyL/MwE/s4WixqXNPT8uMZpMXi22emdRYZjI99i62VHYOFhvI71xzrJuzlc0zzRe+z7JuXhA/30B7551tnGwrnmWYMo6tcywae15NaZvd/5TN/5THV1WXrdrdaJrn7DPHxlknoFnGhQ5BcyycfxSaZWbZ/K0qduXxZZFxZbO/9P7DppnPQs0xc25maoZpOgf1Dy41N88+LWZm0k5sZKOOuy6AXLy9aQld7HjvLU0L/iGU2p5r5cKU9yyDP//w+aaRbA7NvcfxTE/cc+xxzt+3r137WPe5LdqJweqa3HB8E+xRVxXMvsQ/ZG/4bX6TqOV95QLV05NNtAr5YlshrvMUYjTP5/9Qzak6NtfJ1NlcA2Rjixvm8lUVO5oLC+t4uDafXEwX8z2a/9OQ0GtC7dD2Zp3VL1KNXcub9TVt0Z7Fg3tpfbNe7SykWoe2S3TasP2i9uqg2vobq/vy6y2u5/gmkP3QNws90tVUj6buH4Gqod1Nut5UbRxEAuquTedqvKYd/1Zti72eUx3gbou2rI5/U2/qmj1Sx/Oh+ZOvWbge6rob7dRbuSW5/zniH/rOW9qZf2Dvw7A2NW1dkU1EYsmlyz30v6vil1nahw6LdQdn/XNbF616+TZt0dhy3tz/+H4ke6dM+DDz1dBV/OCXZ5myR6dzvisrvTzKbXODdTql80QF3WLrdZ4+F89FXf6zVO866qur/V7Vn/SR6tgOnb/tlWW2qI907opzWx2KttwuVvJARfCjIntK1r7tudZChph4uZGDnO1Fzh9gadNWh1ssHPrf3bLnqj58flXqhuHTIppBxP3tO+/3n7e1Iif8+Qae9/tmlHF3C4/VcfkqfBh6390qnQn//k7rQ8v649eI1vKXO8y2lvPHzvipeFE3rhkt4g9bM6fqpAfhBusuAu5kGykd2Knn4ry/Dt3Icg9/D+5N0rorKktUbzUaFWCAwkqCvMmE9O10YZX5QNf2h0v7RZrfPcUOhropVsjV4VT7uRU2hoaxifgZCJy+lAdVnVtPkR/58S7AcgTKqvmojbNK+Rx1Th1fMG/I63XqP3486UXL0iT093DYGHxLJSRx+lUVw0jZyypBhRNvrEjU2dmyoL6pXJlE4d49PMyZtoeuf2H0ry79l5vVOomeoBW0+Q1Ke1wLVV4az1JoL5LxBaWJQbeayZdMrXZlrbbtT3U5R/bD2O/c9fM/om2/n/PrcntfqDuS2dF3DBYazzCk8bEXXgvGHktU09n+nlQEBGabaTbDQXbnuc/bV3VgH9InfDgINmNH/lm5J/BzGn9TL8X22/fFfv9UbH+hL9ZIDDo3at8J2A4CQu/bhA3zTcKnoi4OqvW4W76lfCqe1U7pJAy7WQWEP9CO049LHsK79NpzffxSCWbANqXv2lbSsWeNMYb/8npkaAXYjWbgvzoe1bb11Nzwgh+MTp6HdOz20Qe+wk6P7nAFp1jtc3Eo99/+bVAK08rNXjea8FK+qeNcC4xONxoQCJ082qfiJ7Hqg2qLXdEWM3STLjcqnznk9xnsY7n9Za7ia5cblZ8CtUMe5ZPFQnLlpQ6K5jz4tceNqvV5duagky7zlVPPzRWDB3x4oLncmxfnXamO/HsDUwoeSGf+yUNPNN/FTNoz5WwWmNNsKz6anjRm7Hk/U85P/1Hb1lsyN21RLyBcLHejYb7DxyzjggeRBQbqFfqprp7L/TLbdP/Tpf8tZnHLXbDEFwRpfLEdJ/AhWFlnW7nsDMzqlZx/herfVF0+l3yNF6ubdJirmM7h//XvCQam0Gwhn8GAH2RETro+y1BfhR6733P6Aik/ryo6cAyhHhhEf+s5O52/Vkau6sEUsx/EiKsGJiagf5njS9nynmrKuL57O3S/l1E71Wzr8uQ78k0ZZXa/n1FmYdJfhhzGMgvNOqXnq6x7maveiv25a/ip2pdbNuc6ZeZVxmmUcS/zxidejLxRwL2x15yf2qU2kb73MmexLXcwxHSf9I6moOdkGt7neOAXPX0w4O2fGcwEDAiGNLOUe7NNAe3hjNMs9YEwIGDAVDQwywTvEShgQPjwM6WeRfqPP34nwfm1mRzlT+VRv2Tge0PFJ/th6CcDG7H/hrm2TRDP9LT6w3PhPVt69R+ei/B5coYBVfU0ewqq6umG4eeB9uWTCGiXZnd2p5bgGc6UWH4LxCz9cohNqpdBzNI/A2KTBvSv8ct1h177D6tloUVfmpdgjGl/lxPkpAL5pHOPdMvsey2Sw2CGSfXELQbTZoluLhCaxmLm8w+fJVC5NruzO7IEz3BHxPKlkZ2tXDbK04ola8PWLV4S0+pPr9VR/f18eOIzVl4Tun7Hsd/NZkxHdrYBwriOVW2hu78JNAxto819athYqdN1bI7BS0oSeN3TxQhS5WMZglz3WH2wRDWdT+6F9MDUBpovSuhVNT/ZU3oeDBmB6Q89nw+EYzsfJTJp3EVCkA9ZYFrA+00aNeUFF5gTigsm7ZkMC2QGUTB/4i7tDaA51H4enLvinmU6Oiifxv78UAQfbG7+Y9qicBpkiTEB4E6bM4XcJQbpuymWWTP0vMmUEGjDYaO/9R8FWDeMnA3Xm8K6KXvmouPmIG/KIEmsN98oKWCdwG8OXCfDP+PGOwFMabv7HG+8kqfPN6zxywHpWiCFosSAUB2X34LJUq45JtS+aw39+sNXF85R7j3i+JWHzzhzlIeKyfz6J+vJJkwwF9pwt3BwkZlt7pJhYoUKkG2ZO6tOgdcZiOql6kK1p7zSydLTgGo6f/SatMAUMs3uMos+uZMTydntdQ/hm+C8NojufpthiNdVeC0Ie4qwanOWyW19wWl2292rcN8rW1K7zz7A3AOF34LwQWKO8iDWfeqnwR40wJxpfWthcIpJgzutYVui4IGolYvXraNXuGJ55XQYfxo+QxIYSKvJXYaSkzk5mLatvsoS3ziySsND6FdJB3G4dLh7sy4wkEyz+70s5xMue1mOewKf1zlpSXWxD9wX7DXm0nnqruAZBu2Vei/YMjCvGZcuNyuXvjroNWXWq4PzDPv8F+6KirnWNc9NJ+WtVO9bKmWJib5VE367kW854/i625XakmK/WM/DVcaJypgehOl3HkOn66BJU+freWaEo5qQIYK4Zp4p5fGt7C9RESwn25prZ+lSmjboUPz6Z/5i4JAlh+LXInAD8DwTjtUCiIyd7mFAVb8Ux/K/xRKEWH3vYc71PYnZCLm+LnEvfHhPPCEzwoeemQb4bgoIGhC8LGDSAPu+U+6y+f7uTvLLDK+93aqmMaNiXtxD3zQcylHrfKHNr6eyVs2f7ctiHX1Dw8J/oYZAW7kTPVu5u/m52AOGR53oZCHQaa4Ij7LwChBoaZ035Tyapt+G47XZGGc50B+/81xOPdE6uBaEmvv7O7vq2XlGMB1vt+fLpzlGXFvPOAexxQByJbfUApCnmzcuMwZl0VwY37zrZes/zYqQa9XYbvsi4+H6u/+c7K8Jr9vXHd2ebOm0xXz5ZhrMlh3OeE3K/Wf/duMuLP/t2mq+nv5ii78XzgXbVyV9kyCVEdLwor+g4QXIw+XnBZL1lRhB07sWiy3vLuzyC7/8PF/yodzt9ipoet9kse3HkOzlUu27LBzJUzdXhKRzTLutQEKnC3VMri6i66Y1Zt+D4eiZuPUiKLtWz6qu1e4nm6R0tIwtJ4nJsD7z/XtXS/j9+pDs5vzkldv/Nl/m+aRd+86Jqq+ShxaBcDok/109NWVgd7n+Pl/2f6ujKulXum3hpIFIenKV3d2596mu3krqnJ/Pxy6TMtziN/4u38pPdXXqPxohEanRcmqH5vwTmHayj3JuVNeKUTn+xD3Az4+r8rhTv64+/nb56MPHFX6IPuSrx9Vzqfa7ZvXx6+hJt9XhoE16XO2q7bn7789Ds38qHUTpxn3rP61Xj1/XjzF+gE3+88+PX8fO3Q/dH0YZ1790HWH1+BUeN+mH9QaMjuB0BKMjrh6/4uMm+pCkidERnY5odIxWj18jTmPkdIyMjpvV49cN94wbp+PG6BivHr/GXMfY6RgbHZPV49eE65g4HROjY7p6/JpyHVOnY2p0zFaPXzOuY+Z0zIyO+erxa851zJ2OuQkAjQdgsQMueMBCTwcfYDszADIRBBoXgGxnF0Rgogg0NiBiO7tAAhNJoPEBLJbABROYaAKNEWDxBC6gwEQUaJwAiylwQQUmqkBjBVhcgQssMJEFGi+QPW7gAySR2dkFF5joAo0ZyFk/4QIMTIShxgyyCEMXYWgiDDVmkEUYughDy0d1TopFGDJuykQYasxgxLo4F2FoIgw1ZnDDDRi6CEMTYagxgzHb2UUYmghDjRlM2M4uwtBEGGrMYMp2dhGGJsJQYwYztrOLMDQRhhozyHowdBGGJsIijZlozW4qLsIiE2GRxkzEIixyERaZCIs0ZiIWYZGLsMjaCbutkN8Lmc3QRFikMROxCItchEUmwiKNmYhFWOQiLDIRFmnMRCzCIhdhkYmwSGMmYn1Y5CIsMhEWZf5ndhEWmQiLNGYidnONXIRFJsI2HcJYeG5chG1MhG00ZjasA9y4CNuYCNtozGxYeG5chG1MhG00ZjYsPDcuwjZWvNUFXOwWu2FCLhNhG42ZDR+uuQjbmAjbJF54blyEbUyEbVKvA9y4CNuYCNtkXmxvXIRtTIRtNGY2vNkuwjYmwuK11/XGLsJiE2ExeF1v7CIsNhEWdwhjnzl2ERabCIsjb2QQuwiLTYTFHcJYZxC7CIutqL5DGLueYyawNxEWa8xs2PUcuwiLTYTFGjMxu55jF2GxibBYYyYGLqyIXYTFJsJijZmYXc+xi7DYRFiy9sIzcRGWmAhLwAuSxEVYYiIsQe8zJy7CEhNhicZMzLqhxEVYYiIs0ZiJN4+YfIjNri6+EhNfSXdsZOP8xMVXYp0cNWJi/uzIHB5NfCUdvthlkbj4Skx8JR2+2GWRuPhKTHwlHb7Y1Zy4+EpMfKUaMQm7LFIXX6mJr1QjJmEhkrr4Sk18pRoxCbssUhdfqYmvVCMmYfGVuvhKTXylGjMJu82lLsJSE2GpxkzCIix1EZaaCEu75ASLsNRFWGrlJzRmEj5DwaQoTISlGjMJi7DURVhqIizVmElYx5u6CEtNhGUaMymLsMxFWGYiLNOYSdlAKnMRlpkIyzRmUhZhmYuwzERYpjGTsgjLXIRlJsIyjZmURVjmIiwzEZZpzKQswjIXYZmJsExjJmURlrkIy0yEZV0KjEVY5iIss7JgGjMpnwdjEmEmwjKNmZRFWOYiLDMRlmvMZCzCchdhuYmwXGMmYxGWuwjLTYTl6E035C7CchNheeRL4+YuwHITYPnGm23IXYDlJsDy2HuEzV2A5SbA8sR7bM9dgOUmwHINmYxdkbkLsNwEWJ75B9sFWG6lWnNvbidnsq12urVDGJ+4XHMJVyvjugZf4r3/ye5u5VzX6Eu/9z/Z3a2s6zryxFP9L3ZvK+261uDJ2JHrf7P7W5nXdewNT/rf7P5W8nWtIZTxqds1k35dW/nXdYc5Pnu7ZjKwaysFu+7S++wZr//N7m9lYdcaSxnrF/vf7P4W9rrsfcaPH5fsd7L9Gkw5zxWw+X4LfF0OP+fpJi7lb+f8uzR+jnx/Bn922r/L5Of82uMS/3bmv0vm5zx+udy/nfzv8vk5jz8u/W/n/7uUfs7jj2MAbAqgy+rnKes8OBLAZgG6xH6ePUb5B4hTqz+DP4sIgC63n7NbMzBUAFhcAHTpfVjzAGToALD4AOhS/Kz7YvgAsAgB6HL8sObxy3ACYJEC0OX5+UMOMLQAWLwAdKl+WPMLgKEGwOIGoEv3w5r3/ww9ABY/AF3KH9b8EmAoArA4AujS/rBmww1gaAKweALoUv+w5hcBQxWAxRVA1BOe6WOUfthk1iwwdAFYfAF0FAALIoYvAIswgI4DgHX2GCUf1rEtgEGhRRpA1KOQX0UMbwAWcQAdFwAeypfhDsAiD6DjA8BD+zL8AVgEAnScAHioX4ZDAItEgI4XAGADOGB4BLCIBIgCOzFDJYDFJUBHD4CHQmboBLD4BOgoAvDQyAylABanABsvChlOASxSATqeAIDN5wHDK4BFLEDHFXhCOYZaAItbgE0PQp7MZugFsPgF2PQg5IMhhmIAi2OATQ9Cfh0xNANYPAN01AHwxDYwVANYXAN09AHw5DYwdANYfAN0FALwBDcwlANYnAN0NAIgHxExtANYvAN0VAIgvw4Y6gEs7gHivgjEU07BANHiH6AnIDzunKEgwOIgIN4EfAlDQ4DFQ0BHLXiiIoaJAIuKgI5dYFcyQ0WAxUVAnAb2E4aOAIuPgLhHIb+hMpQEWJwExD0K+aXM0BJg8RLQUQ3sADC8BFjEBCQ9BPnKFoabAIucgKSHIO8IGH4CLIICkr4WiXcEDEcBFkkBHfPgwzDDVIBFVUDPVbAjyADQ4iqgox+8I8iVJVkY7CgI4GsogKEswOIsoKMhgK+jAIa2AIu3gJ64YAeAAaBFXEC6DgwAw12ARV5Ax0dAxPtRhr8Ai8CAjpOAiPejDIcBFokBacgNMjwGWEQGpCE3yHAZYJEZkHoxyJAZYLEZ0BEUoDl/Tj2DQYvRgDTkBxlSAyxWA9Ieg7wfZIgNsJgN6MgKPjPHUBtgcRvQ0RWe5ALDboBFb0DWY5B3wwzDARbFAVmPQT6iYlgOsGgOyHo/yDtShukAi+qArK/LZDPCwLAdYNEdkHkxyNAdYPEdkIX8IEN5gMV5QEdjAF+sAwztARbvAR2VARv+gM9QH2BxH5AFMjQM+wEW/QG5dytm6A+w+A/oKA3Y8OkFhgIBiwOBjtYAvmwIGBoELB4EeiLEM4AMFwIWGQK5r2AAGDIELDYEOoLD58UYQgQsRgQ6ksM7ggwELVYE8h6CfDzNECNgMSOQZ4GNhCFHwGJHIPduxQw7AhY9guu1P0OFDD+CFj+C6x6DrBtHhiFBiyHBdSBBgwxHghZHguvIn+JChiZBiybBde8GWU+ODE+CFk+Ca58bRIYlQYslwXXizw0gQ5OgRZPgOvXnSZHhSdDiSXDdu0F2J0KGKEGLKMG1D4PI0CRo0STYvxLBbgPI0CRo0STYvxXhQRDDk6DFk2D/ZgRfnoYMUYIWUYI9UcIm+pEhStAiSrAnSthtBBmiBC2iBMELQIYmQYsmwf4lCb7ADhmeBC2eBDveg1fPoM9iSTDwpgQyLAlaLAn2L0vEnncWGPzZ70ugbxNG7n0J+4WJniThiwSRe2fCeWmiQx9fcYfsexMW+jrag6f5kHt1wn53oqM9IGajAORen7Dfn+h5Er52D7lXKOx3KDragycakXuLwn6NoqdJ+Po/5N6ksF+l6GkSvgYQubcp7NcpepqErwNE7o0KiybBEE2CDE2CFk2CHfHh8UEMUYIWUYI9URLzTpAhStAiSrAnSviCRGSIErSIEuyJkoRfyAxRghZRgj1RwhcmIkOUoEWUYE+U8MWJyBAlaBElGAVOxcgQJWgRJdgTJWzJADJECVpECfZECV8hiQxRghZRgj1RwldJIkOUoEWUYEd9AF8piQxXghZXgj1XwldLIsOVoMWVYMd9eDYUhitBiyvBnivxTCLDlaDFlWDPlfAlm8hwJWhxJdhzJXzZJjJcCVpcCfZcCV+6iQxXghZXgj1XwpdvIsOVoMWVYM+V8LkFZLgStLgS7LkSvgYUGa4ELa4EO+qDr4JHhipBiyrBnirh60iRoUrQokqwp0r4WlJkqBK0qBKMA2Ehw5SgxZRgx3wAX4+KDFWCFlWCHfkBfE0qMmwJWmwJ9mwJX5eKDFuCFluCPVvC16Yiw5agxZZgz5bw9anIsCVosSWY9KcTfikxhAlahAkm/lJ7ZPgStPgS7PkSvgoFGb4ELb4EB76EzZIgw5egxZdgz5fwlbbI8CVo8SWYxP4yFmQoE7QoE+wpE778FBnKBC3KBHvKhK8DRYYyQYsywZ4yyfjFzFAmaFEm2JEgwFdDIsOaoMWaYM+a8OWQyLAmaLEm2LMmGb8YGdYELdYEe9aEL4hEhjVBizXBnjXJ+MXIsCZosSbYsyZ8SSQyrMn4t+4qkDdVt2r31/5KkK9fV8a1jr+t/j1cFqKDn06dvjdEhzcff/v99+v1IB9/+53cEKJ/0xr5+3uJ0DgjQjGXCu2vRSNy0ojIiVEm53KTLxG0Tq+CdM1V11Wz9f1/ks3wn3T8S571/8FIOCTn9tXQSPT1XfJILGit74ZWv7aXq0ep5Ig8SpTKZVbjZepXURkZXl0LLpZ1uty0Q544o5OeSierfV3Xlxv9rtJiYloiH7nhq4llddyrN7U37AOKgc1mrsz+S4xEXpQTeZncxu4SWGNGN2RGByRG2Tx53fW7V5FEovxBR0EcUhKKFDnqOpHvZfs6XB1IHpqgJRJ6CEPgr9vX4viijkVbvqmm2paFKZ/MjtStUflV9WQM6JqIgwXi9Ce7iTjiHzbypXIRN34Ka/gkFRGMRPBMTGrB5oejiVyyHmesnYvc5mDgaUMBGovFjZ/mI6uQPrBmLAf3LX/04eJm4nqIxFiMzOpQtOWWyknJHGcyyDwVjVJ1XRmOFZFupjI5/V209iTqOqrrYAmfjVwoSnfmDd2ZZaO9LY5btW/Ldm/Kgow6Zhkaelnv6sneeCMSz0Rx33uTyGSat9lSkK0pyAYXrQ/xIrF7VdRbep83mVviVzEZrJW5107s5dMfZACIyGgUKdtNqEhmE8jpKIAM0VQkHyzmNAgBmWu5fhibDCUZycELrGEM64QzZa8XoLb1wZYOGy/RotBa8kkH8tx0LcIYbkI0xp3C8a2OTVuf9Y19xmDQwHkQmQ/DkgvBUKuiVefGjPLI6hIu1IsYDlE0rAAh7vmVBAn1SMKIgsg6FMfixXxWpEejwZXkwik/1/rGxyGON3YFgtNM5s37rw4ZQsj0CiNP89NFZAroSQUGiCDKhO7Uc3HeG8+XEXm5DMM71Wzr8mQvEF0+T/YFmQ/fqbdyq67zSgVShAiXri3uefiwkLmrUr8o9N694Or9aEIuIVthKlunRJIOtJ7K6qDautwaqyMhQyl0hrvqUJTmzkI2ltHDyhDsRP853fIhHx3rsMh05djgDse9NpbNl3WDOA1YjMUs813q+GYMIpnnVHakcL/RRbMk1GOh8AHt6HBDnmszDFsiNO6t2J+7w/Kp2pfbbyaoqV8Qxg/jmcwYNHKOnyXEd7Aj26ZsqXECmb1Iv/Z3fWJh0mqUzckDejKJpA9/+RgK3dpolCg8fY6eyg236XkChDFsf2n+v7tudBlTD40y1NH79+n6pM8Yy0brWe1UrW+7NmzaUNdy8ShC46r60LwqZW7ZRGImW6bP5/2+2dbKTLZSH5TJXND4PQE6UikdKdkaeFGt7wRCpQ0RbiwbrBfV2uFhRLyGMIIdpLArKKZIFRqlv5HgAFW/102QKrTs+rkFOvw0zRnLHONr0bwV+3LnmwMqcjgJxDIbL9/5JCE6geslsb0ed2wcD0fReDjajP+Jh9MiJGOCPBmXTzJu0ellQY3/ycfG+agrH3fvdTz+57Kfj3+BdIw0ZdNq5V6B+urNGLWuZW7j8hUo6mLpMhBm5KyP49GdnfhFXTokktbsq0JnbYzdnTxnPDxmIkPGfxoz3IjJYkpkzmf8tCd9MhpGoVCM/rLIRHY+IcFlKjt8MGK5zDXdDtYjRIWpUUZF0+od58UYFQqeVOaQx6+tUMdCQSNMzu2rl/LI5teJS5H5KFMU547peRiEbNxFqpVPJ88680mr6ok1jnoEoVu+yjSz80A3C5l/oqI48yIqUkhoXWT6kvJgnN2Xy2QNplFiMnM8rWy/EQnPxE1zaFjz6LIWko376qU6t7avNlJ88+SwhlEcCo/w47dN6X60pjuIzK6Daotd0RYmlClGxlQgCim8w3PhbpU0WoFkDB6SMXhIx3ggk+3G9MtQlE2mAyA80B6u34C75PLNPD6NGhaLrKonjrIGmmRBYb7KI7/P5HQkDqsqpaMjTDmxqjgE0/kVpihZ2e2Jtx2o7cIVwsjnhVMaQHiOsbGXEAPTEd84ZqKE4df102F0MRqOcIyFE9kYD98fpoCjIxnJAH2sjoYQeu4WrtjKSH/GNMMjFFA9udQkTSUIR8T8EjIdGIqCSBal2jEAPcrqOwVEMt5UHUj9kzAxkwv05BJogCdbRKfiRbnJDTLumSwUG4sPTGjTfXSkMlFYVDRK3KumYaNZIxMgm09WJufvaC0GCOfFFm4HPDQIkK0JRiJrLN3Cctky8RaLGBVR8x68k8UaSGcqlwptt69OKomsYeER+iKHNYye8NcyZ2l8npH6BvqQ6Rj55BeHLovX2A8y0hCIuvdEaPH48UW6NClmxhwfCnMAp+qknZBxtCTBRy5c4O7XGumDUnct3EMuX2akcijrLXTZ5Jt9VBIN5YT5CHd50ewNrmVxg/esF1EHm0qF7cpaaUSUxgTSdb8ea6aEJYdXmaaHToySA9kkmh9Ip+NPXfIAWFiP/xn/IsziUC2sZ6Dp17V0FBrVshshjWOGtKewPsqQyRpKUSk8SI9Rsl3TRKt1YS3b+GvVnutjW5m4pGAS1rmNgiwM5dStCvfNWr1VvxhPRul4YXa5F8INeUyFzTLJh226DwlZ7aZ4LuryrVTvOqqsq/1e1fpspY7tkJP8ZnpCejwUMl9N8aZ89ASFnQwpzbaySujWFG/RSELEY01VOm5L6zGZD8PJC8e6KxTWnTbqaK5IWrsK+Xigy2WTqaV1oaNTEUseSFhPoGVN5SjoGhfSoFpsc2hsAyl0hTShUwtL90G4OGDhTqGlnU1qimBfuD83bV2ZnAh9YyUVDvz5ydxeaOWFMLnZnJ/+o7atu1et6RgJU3VUmFNtaqSfhcf65vzEMP0U+MJkSKv2ShcQGQQH5bMuVOBaNvb2KZi+GyQc+rY8qOpslpnRrULI+w1inBIaGn4KTyzMWNMgW0jeuliKjVrvGVIcENFKMhQWVdtC6DON+a9ctgE4ITXBtAyI5EPmdOVS/jGR2XJuVNF/UZuGaXRjF1YDnhu1Vy/F9tt2KK6x4xea3rtU8qIMnU6lLTn9xUPEm4yboxBgWmb/RXUyqfRUOU8MGyAZ4sQT4h4C13RFj1UQuJb5Uy2ROxEaDJkwEahlGc9Iubvx3UFh9HBuVPPMhW/mGNJzIso80JAxMAUZBIewBnr8WDzdYQmOhdzauyqMrDAtWUtlY8W9zEFLTscydtksDtK6F5BY3NLjqvC1GirT9+YrzTKhbHt7V09Nab1fQ1+4Q2Gx6X+ro7JXO2RGfZdgvf/8uDqVJ7Uvj2r18evPv//+/6VzCuo="; \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css index 973d4371..7c3fbdb9 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,1623 +1,1640 @@ @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/TimeoutError.html b/docs/classes/TimeoutError.html index 99d9333b..843ec717 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,500 +1,3 @@ - - - - - - TimeoutError | react-native-auth0 - - - - - - - - - - - - -
-
- react-native-auth0 - - - - -
    -
    -
    Preparing search index...
    -
    -     - -
    -
    -
    -
    -
    - -

    Class TimeoutError

    -
    -
    -

    - Hierarchy (View Summary) -

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

    Constructors

    -
    - - constructor -
    -
    -
    -

    Properties

    -
    - - type -
    -
    -
    -
    -
    -
    -
    - - -

    Constructors

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

    Properties

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

    Settings

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

    On This Page

    -     -
    -
    - - Constructors - - -
    -
    - - Properties - -
    - - type -
    -
    -
    -
    -
    -
    - -
    -
    -
    -
    -

    - Generated using - TypeDoc -

    -
    -
    - - +TimeoutError | react-native-auth0
    react-native-auth0
      Preparing search index...

      Class TimeoutError

      Hierarchy (View Summary)

      Index

      Constructors

      constructor +

      Properties

      type +

      Constructors

      Properties

      type: string

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      diff --git a/docs/classes/Types.Auth.html b/docs/classes/Types.Auth.html index 605b0b5f..0549ebe7 100644 --- a/docs/classes/Types.Auth.html +++ b/docs/classes/Types.Auth.html @@ -1,2557 +1,74 @@ - - - - - - Auth | react-native-auth0 - - - - - - - - - - - - -
      -
      - react-native-auth0 - - - - -
        -
        -
        Preparing search index...
        -
        -         - -
        -
        -
        -
        -
        - -

        Class Auth

        -
        -
        -
        -

        - Class for interfacing with the Auth0 Authentication API endpoints. -

        -
        -
        -
        - -

        - https://auth0.com/docs/api/authentication -

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

        Properties

        -
        - - clientId - - domain -
        -
        -
        -

        Methods

        -
        - - authorizeUrl - - createUser - - exchange - - exchangeNativeSocial - - loginWithEmail - - loginWithOOB - - loginWithOTP - - loginWithRecoveryCode - - loginWithSMS - - logoutUrl - - multifactorChallenge - - passwordlessWithEmail - - passwordlessWithSMS - - passwordRealm - - refreshToken - - resetPassword - - revoke - - userInfo -
        -
        -
        -
        -
        -
        -
        - - -

        Properties

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

        The Auth0 client ID

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

        The Auth0 tenant domain

        -
        -
        - -
        -
        -
        -
        - - -

        Methods

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

          Creates a new user using the options provided.

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<Partial<User>> -

          -

          - An instance of <a href="../types/User.html" - class="tsd-kind-type-alias">User</a>. -

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

          - Completes the Passworldess authentication with an email - connection that was started using <a - href="#passwordlesswithemail" - class="tsd-kind-method">passwordlessWithEmail</a>. -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<Credentials> -

          -

          - A populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -

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

          - Log in a user using an Out Of Band authentication code - after they have received the 'mfa_required' error. The - MFA token tells the server the username or email, - password, and realm values sent on the first request. -

          -

          - Requires your client to have the - MFA OOB Grant Type enabled. See - Client Grant Types - to learn how to enable it. -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<Credentials> -

          -

          - A populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -

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

          - Log in a user using the One Time Password code after - they have received the 'mfa_required' error. The MFA - token tells the server the username or email, password, - and realm values sent on the first request. -

          -

          - Requires your client to have the - MFA OTP Grant Type enabled. See - Client Grant Types - to learn how to enable it. -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<Credentials> -

          -

          - A populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -

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

          - Log in a user using a multi-factor authentication - Recovery Code after they have received the - 'mfa_required' error. The MFA token tells the server the - username or email, password, and realm values sent on - the first request. -

          -

          - Requires your client to have the - MFA Grant Type enabled. See - Client Grant Types - to learn how to enable it. -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<Credentials> -

          -

          - A populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -

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

          - Completes the Passworldess authentication with an SMS - connection that was started using <a - href="#passwordlesswithsms" - class="tsd-kind-method">passwordlessWithSMS</a>. -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<Credentials> -

          -

          - A populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -

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

          - Request a challenge for multi-factor authentication - (MFA) based on the challenge types supported by the - application and user. The challenge type is how the user - will get the challenge and prove possession. Supported - challenge types include: "otp" and - "oob". -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<MultifactorChallengeResponse> -

          -

          - <a - href="../types/MultifactorChallengeOTPResponse.html" - class="tsd-kind-type-alias">MultifactorChallengeOTPResponse</a>, - <a - href="../types/MultifactorChallengeOOBResponse.html" - class="tsd-kind-type-alias">MultifactorChallengeOOBResponse</a>, - or <a - href="../types/MultifactorChallengeOOBWithBindingResponse.html" - class="tsd-kind-type-alias">MultifactorChallengeOOBWithBindingResponse</a> - depending on the challenge type. -

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

          - Starts the Passworldess flow with an email connection. -

          -

          - This should be completed later using a call to <a - href="#loginwithemail" - class="tsd-kind-method">loginWithEmail</a>, - passing the OTP that was sent to the user. -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<void> -

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

          - Starts the Passwordless flow with an SMS connection. -

          -

          - This should be completed later using a call to <a - href="#loginwithsms" - class="tsd-kind-method">loginWithSMS</a>, - passing the OTP that was sent to the user. -

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<void> -

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

          Revoke an issued refresh token

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<void> -

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

          Return user information using an access token

          -
          -
          -

          Parameters

          - -
          -

          - Returns Promise<User> -

          -

          The user's profile information.

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

        Settings

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

        On This Page

        -         -
        -
        - - Properties - - -
        -
        - - Methods - - -
        -
        -
        -
        -
        - -
        -
        -
        -
        -

        - Generated using - TypeDoc -

        -
        -
        - - +Auth | react-native-auth0
        react-native-auth0
          Preparing search index...

          Class Auth

          Class for interfacing with the Auth0 Authentication API endpoints.

          +

          https://auth0.com/docs/api/authentication

          +
          Index

          Properties

          clientId +domain +

          Methods

          authorizeUrl +createUser +exchange +exchangeNativeSocial +loginWithEmail +loginWithOOB +loginWithOTP +loginWithRecoveryCode +loginWithSMS +logoutUrl +multifactorChallenge +passwordlessWithEmail +passwordlessWithSMS +passwordRealm +refreshToken +resetPassword +revoke +userInfo +

          Properties

          clientId: string

          The Auth0 client ID

          +
          domain: string

          The Auth0 tenant domain

          +

          Methods

          • Completes the Passworldess authentication with an email connection that was started using <a href="#passwordlesswithemail" class="tsd-kind-method">passwordlessWithEmail</a>.

            +

            Parameters

            Returns Promise<Credentials>

            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

            +

          • Log in a user using an Out Of Band authentication code after they have received the 'mfa_required' error. +The MFA token tells the server the username or email, password, and realm values sent on the first request.

            +

            Requires your client to have the MFA OOB Grant Type enabled. See Client Grant Types to learn how to enable it.

            +

            Parameters

            Returns Promise<Credentials>

            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

            +

          • Log in a user using the One Time Password code after they have received the 'mfa_required' error. +The MFA token tells the server the username or email, password, and realm values sent on the first request.

            +

            Requires your client to have the MFA OTP Grant Type enabled. +See Client Grant Types to learn how to enable it.

            +

            Parameters

            Returns Promise<Credentials>

            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

            +

          • Log in a user using a multi-factor authentication Recovery Code after they have received the 'mfa_required' error. +The MFA token tells the server the username or email, password, and realm values sent on the first request.

            +

            Requires your client to have the MFA Grant Type enabled. See Client Grant Types to learn how to enable it.

            +

            Parameters

            Returns Promise<Credentials>

            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

            +

          • Completes the Passworldess authentication with an SMS connection that was started using <a href="#passwordlesswithsms" class="tsd-kind-method">passwordlessWithSMS</a>.

            +

            Parameters

            Returns Promise<Credentials>

            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

            +

          • Request a challenge for multi-factor authentication (MFA) based on the challenge types supported by the application and user. +The challenge type is how the user will get the challenge and prove possession. Supported challenge types include: "otp" and "oob".

            +

            Parameters

            Returns Promise<MultifactorChallengeResponse>

            <a href="../types/MultifactorChallengeOTPResponse.html" class="tsd-kind-type-alias">MultifactorChallengeOTPResponse</a>, <a href="../types/MultifactorChallengeOOBResponse.html" class="tsd-kind-type-alias">MultifactorChallengeOOBResponse</a>, or <a href="../types/MultifactorChallengeOOBWithBindingResponse.html" class="tsd-kind-type-alias">MultifactorChallengeOOBWithBindingResponse</a> depending +on the challenge type.

            +

          • Starts the Passworldess flow with an email connection.

            +

            This should be completed later using a call to <a href="#loginwithemail" class="tsd-kind-method">loginWithEmail</a>, passing the OTP that was sent to the user.

            +

            Parameters

            Returns Promise<void>

          • Starts the Passwordless flow with an SMS connection.

            +

            This should be completed later using a call to <a href="#loginwithsms" class="tsd-kind-method">loginWithSMS</a>, passing the OTP that was sent to the user.

            +

            Parameters

            Returns Promise<void>

          Settings

          Member Visibility

          On This Page

          Properties
          Methods
          diff --git a/docs/classes/Types.BaseError.html b/docs/classes/Types.BaseError.html index 3af4ac11..b4fa730d 100644 --- a/docs/classes/Types.BaseError.html +++ b/docs/classes/Types.BaseError.html @@ -1,515 +1,3 @@ - - - - - - BaseError | react-native-auth0 - - - - - - - - - - - - -
          -
          - react-native-auth0 - - - - -
            -
            -
            Preparing search index...
            -
            -             - -
            -
            -
            -
            -
            - -

            Class BaseError

            -
            -
            -

            - Hierarchy (View Summary) -

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

            Constructors

            -
            - - constructor -
            -
            -
            -

            Properties

            -
            - - type -
            -
            -
            -
            -
            -
            -
            - - -

            Constructors

            -             -
            -
            - -
              -
            • - -
              -
              -

              Parameters

              -
                -
              • - name: - string -
                • -
              • - message: - string -
                • -
              • - Optionaltype: - string -
                • -
              -
              -

              - Returns - BaseError -

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

            Properties

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

            Settings

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

            On This Page

            -             -
            -
            - - Constructors - - -
            -
            - - Properties - -
            - - type -
            -
            -
            -
            -
            -
            - -
            -
            -
            -
            -

            - Generated using - TypeDoc -

            -
            -
            - - +BaseError | react-native-auth0
            react-native-auth0
              Preparing search index...

              Class BaseError

              Hierarchy (View Summary)

              Index

              Constructors

              constructor +

              Properties

              type +

              Constructors

              • Parameters

                • name: string
                • message: string
                • Optionaltype: string

                Returns BaseError

              Properties

              type: string

              Settings

              Member Visibility

              On This Page

              Constructors
              Properties
              diff --git a/docs/classes/Types.CredentialsManager.html b/docs/classes/Types.CredentialsManager.html index bbeb07ae..c6e9c9a7 100644 --- a/docs/classes/Types.CredentialsManager.html +++ b/docs/classes/Types.CredentialsManager.html @@ -1,768 +1,16 @@ - - - - - - CredentialsManager | react-native-auth0 - - - - - - - - - - - - -
              -
              - react-native-auth0 - - - - -
                -
                -
                Preparing search index...
                -
                -                 - -
                -
                -
                -
                -
                - -

                Class CredentialsManager

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

                Methods

                -
                - - clearCredentials - - getCredentials - - hasValidCredentials - - saveCredentials -
                -
                -
                -
                -
                -
                -
                - - -

                Methods

                -                 -
                -
                - -
                  -
                • - -
                  -
                  -

                  Delete the stored credentials

                  -
                  -

                  - Returns Promise<void> -

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

                  Gets the credentials that has already been saved

                  -
                  -
                  -

                  Parameters

                  -
                    -
                  • - Optionalscope: - string -
                    -

                    - The scope to request for the access token. If null - is passed, the previous scope will be kept. -

                    -
                    -
                    -
                    • -
                  • - minTtl: - number - = 0 -
                    -

                    - The minimum time in seconds that the access token - should last before expiration. -

                    -
                    -
                    -
                    • -
                  • - parameters: - Record<string, - unknown> - = {} -
                    -

                    - Additional parameters to send in the request to - refresh expired credentials. -

                    -
                    -
                    -
                    • -
                  • - forceRefresh: boolean - = false -
                    -

                    - Whether to force refresh the credentials. It will - work only if the refresh token already exists. For - iOS, doing forceRefresh will not send the scope. - Since scope change already does force refresh, it - is better to avoid force refresh if the scope is - being changed. -

                    -
                    -
                    -
                    • -
                  -
                  -

                  - Returns Promise<Credentials> -

                  -

                  - A populated instance of <a - href="../types/Credentials.html" - class="tsd-kind-type-alias">Credentials</a>. -

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

                  - Returns whether this manager contains a valid - non-expired pair of credentials. -

                  -
                  -
                  -

                  Parameters

                  -
                    -
                  • - minTtl: - number - = 0 -
                    -

                    - The minimum time in seconds that the access token - should last before expiration -

                    -
                    -
                    -
                    • -
                  -
                  -

                  - Returns Promise<boolean> -

                  -

                  - true if a valid set of credentials are - available, or false if there are no - credentials to return. -

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

                Settings

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

                On This Page

                -                 -
                -
                - - Methods - - -
                -
                -
                -
                -
                - -
                -
                -
                -
                -

                - Generated using - TypeDoc -

                -
                -
                - - +CredentialsManager | react-native-auth0
                react-native-auth0
                  Preparing search index...

                  Class CredentialsManager

                  Index

                  Methods

                  clearCredentials +getCredentials +hasValidCredentials +saveCredentials +

                  Methods

                  • Gets the credentials that has already been saved

                    +

                    Parameters

                    • Optionalscope: string

                      The scope to request for the access token. If null is passed, the previous scope will be kept.

                      +
                    • minTtl: number = 0

                      The minimum time in seconds that the access token should last before expiration.

                      +
                    • parameters: Record<string, unknown> = {}

                      Additional parameters to send in the request to refresh expired credentials.

                      +
                    • forceRefresh: boolean = false

                      Whether to force refresh the credentials. It will work only if the refresh token already exists. For iOS, doing forceRefresh will not send the scope. Since scope change already does force refresh, it is better to avoid force refresh if the scope is being changed.

                      +

                    Returns Promise<Credentials>

                    A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

                    +

                  • Returns whether this manager contains a valid non-expired pair of credentials.

                    +

                    Parameters

                    • minTtl: number = 0

                      The minimum time in seconds that the access token should last before expiration

                      +

                    Returns Promise<boolean>

                    true if a valid set of credentials are available, or false if there are no credentials to return.

                    +

                  Settings

                  Member Visibility

                  On This Page

                  Methods
                  diff --git a/docs/classes/Types.Users.html b/docs/classes/Types.Users.html index 1350c768..eef23870 100644 --- a/docs/classes/Types.Users.html +++ b/docs/classes/Types.Users.html @@ -1,648 +1,16 @@ - - - - - - Users | react-native-auth0 - - - - - - - - - - - - -
                  -
                  - react-native-auth0 - - - - -
                    -
                    -
                    Preparing search index...
                    -
                    -                     - -
                    -
                    -
                    -
                    -
                    - -

                    Class Users

                    -
                    -
                    -
                    -

                    Auth0 Management API User endpoints

                    -
                    -
                    -
                    - -
                    -
                    - -

                    - https://auth0.com/docs/api/management/v2#!/Users/ - Users -

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

                    Methods

                    -
                    - - getUser - - patchUser -
                    -
                    -
                    -
                    -
                    -
                    -
                    - - -

                    Methods

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

                    Settings

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

                    On This Page

                    -                     -
                    -
                    - - Methods - - -
                    -
                    -
                    -
                    -
                    - -
                    -
                    -
                    -
                    -

                    - Generated using - TypeDoc -

                    -
                    -
                    - - +Users | react-native-auth0
                    react-native-auth0
                      Preparing search index...

                      Class Users

                      Auth0 Management API User endpoints

                      +

                      https://auth0.com/docs/api/management/v2#!/Users/ +Users

                      +
                      Index

                      Methods

                      getUser +patchUser +

                      Methods

                      Settings

                      Member Visibility

                      On This Page

                      Methods
                      diff --git a/docs/classes/Types.WebAuth.html b/docs/classes/Types.WebAuth.html index bb342c5e..86081e73 100644 --- a/docs/classes/Types.WebAuth.html +++ b/docs/classes/Types.WebAuth.html @@ -1,707 +1,18 @@ - - - - - - WebAuth | react-native-auth0 - - - - - - - - - - - - -
                      -
                      - react-native-auth0 - - - - -
                        -
                        -
                        Preparing search index...
                        -
                        -                         - -
                        -
                        -
                        -
                        -
                        - -

                        Class WebAuth

                        -
                        -
                        -
                        -

                        Helper to perform Auth against Auth0 hosted login page

                        -

                        - It will use /authorize endpoint of the Authorization - Server (AS) with Code Grant and Proof Key for Challenge Exchange - (PKCE). -

                        -
                        -
                        -
                        - -

                        - https://auth0.com/docs/api-auth/grant/authorization-code-pkce -

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

                        Methods

                        -
                        - - authorize - - cancelWebAuth - - clearSession -
                        -
                        -
                        -
                        -
                        -
                        -
                        - - -

                        Methods

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

                          - Terminates the ongoing web-based operation and reports - back that it was cancelled. You need to call this method - within your custom Web Auth provider implementation - whenever the operation is cancelled by the user. -

                          -
                          -

                          - Returns Promise<void> -

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

                        Settings

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

                        On This Page

                        -                         -
                        -
                        - - Methods - - -
                        -
                        -
                        -
                        -
                        - -
                        -
                        -
                        -
                        -

                        - Generated using - TypeDoc -

                        -
                        -
                        - - +WebAuth | react-native-auth0
                        react-native-auth0
                          Preparing search index...

                          Class WebAuth

                          Helper to perform Auth against Auth0 hosted login page

                          +

                          It will use /authorize endpoint of the Authorization Server (AS) +with Code Grant and Proof Key for Challenge Exchange (PKCE).

                          +

                          https://auth0.com/docs/api-auth/grant/authorization-code-pkce

                          +
                          Index

                          Methods

                          authorize +cancelWebAuth +clearSession +

                          Methods

                          • Terminates the ongoing web-based operation and reports back that it was cancelled. +You need to call this method within your custom Web Auth provider implementation whenever the operation is +cancelled by the user.

                            +

                            Returns Promise<void>

                          Settings

                          Member Visibility

                          On This Page

                          Methods
                          diff --git a/docs/classes/default.html b/docs/classes/default.html index daa5159c..b4a821f0 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -1,878 +1,18 @@ - - - - - - default | react-native-auth0 - - - - - - - - - - - - -
                          -
                          - react-native-auth0 - - - - -
                            -
                            -
                            Preparing search index...
                            -
                            -                             - -
                            -
                            -
                            -
                            -
                            - -

                            Class default

                            -
                            -
                            -
                            -

                            Auth0 for React Native client

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

                            Constructors

                            -
                            - - constructor -
                            -
                            -
                            -

                            Properties

                            -
                            - - auth - - credentialsManager - - webAuth -
                            -
                            -
                            -

                            Methods

                            -
                            - - users -
                            -
                            -
                            -
                            -
                            -
                            -
                            - - -

                            Constructors

                            -                             -
                            -
                            - -
                              -
                            • - -
                              -
                              -

                              Creates an instance of Auth0.

                              -
                              -
                              -

                              Parameters

                              -
                                -
                              • - options: - {
                                    clientId: - string;
                                    domain: - string;
                                    localAuthenticationOptions?: - LocalAuthenticationOptions;
                                    telemetry?: - Telemetry;
                                    timeout?: - number;
                                    token?: - string;
                                }                                 -
                                -

                                Your Auth0 application information

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

                                  Your Auth0 application client identifier

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

                                  Your Auth0 domain

                                  -
                                  -
                                  -
                                  • -
                                • -
                                  - OptionallocalAuthenticationOptions?: LocalAuthenticationOptions -
                                  -
                                  -

                                  - The options for configuring the display of - local authentication prompt, authentication - level (Android only) and evaluation policy - (iOS only). -

                                  -
                                  -
                                  -
                                  • -
                                • -
                                  - Optionaltelemetry?: Telemetry -
                                  -
                                  -

                                  - The telemetry information to be sent along - with the requests -

                                  -
                                  -
                                  -
                                  • -
                                • -
                                  - Optionaltimeout?: number -
                                  -
                                  -

                                  Timeout to be set for requests.

                                  -
                                  -
                                  -
                                  • -
                                • -
                                  - Optionaltoken?: string -
                                  -
                                  -

                                  Token to be used for Management APIs

                                  -
                                  -
                                  -
                                  • -
                                -
                                • -
                              -
                              -

                              - Returns - default -

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

                            Properties

                            -                             -
                            -
                            - -
                            - auth: - Auth -
                            - -
                            -
                            - -
                            - credentialsManager: - CredentialsManager -
                            - -
                            -
                            - -
                            - webAuth: - WebAuth -
                            - -
                            -
                            -
                            -
                            - - -

                            Methods

                            -                             -
                            -
                            - -
                              -
                            • - -
                              -
                              -

                              Creates a Users API client

                              -
                              -
                              -

                              Parameters

                              -
                                -
                              • - token: - string -
                                -

                                for Management API

                                -
                                -
                                -
                                • -
                              -
                              -

                              - Returns - Users -

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

                            Settings

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

                            On This Page

                            -                             -
                            -
                            - - Constructors - - -
                            -
                            - - Properties - - -
                            -
                            - - Methods - - -
                            -
                            -
                            -
                            -
                            - -
                            -
                            -
                            -
                            -

                            - Generated using - TypeDoc -

                            -
                            -
                            - - +default | react-native-auth0
                            react-native-auth0
                              Preparing search index...

                              Class default

                              Auth0 for React Native client

                              +
                              Index

                              Constructors

                              constructor +

                              Properties

                              auth +credentialsManager +webAuth +

                              Methods

                              users +

                              Constructors

                              • Creates an instance of Auth0.

                                +

                                Parameters

                                • options: Auth0Options

                                  Your Auth0 application information

                                  +

                                  Options for configuring the Auth0 client.

                                  +
                                  • clientId: string

                                    The client identifier of your application.

                                    +
                                  • domain: string

                                    The Auth0 domain for your tenant.

                                    +
                                  • Optionalheaders?: Record<string, string>

                                    (Optional) Custom headers to include in requests.

                                    +
                                  • OptionallocalAuthenticationOptions?: LocalAuthenticationOptions

                                    Options for configuring local authentication.

                                    +
                                  • Optionaltelemetry?: Telemetry

                                    Telemetry information to include in requests.

                                    +
                                  • Optionaltimeout?: number

                                    The timeout in milliseconds for network requests.

                                    +

                                Returns default

                              Properties

                              auth: Auth
                              credentialsManager: CredentialsManager
                              webAuth: WebAuth

                              Methods

                              • Creates a Users API client

                                +

                                Parameters

                                • token: string

                                  for Management API

                                  +

                                Returns Users

                              Settings

                              Member Visibility

                              On This Page

                              Constructors
                              Properties
                              Methods
                              diff --git a/docs/enums/LocalAuthenticationLevel.html b/docs/enums/LocalAuthenticationLevel.html index 8a3df491..b6164f70 100644 --- a/docs/enums/LocalAuthenticationLevel.html +++ b/docs/enums/LocalAuthenticationLevel.html @@ -1,464 +1,8 @@ - - - - - - LocalAuthenticationLevel | react-native-auth0 - - - - - - - - - - - - -
                              -
                              - react-native-auth0 - - - - -
                                -
                                -
                                Preparing search index...
                                -
                                -                                 - -
                                -
                                -
                                -
                                -
                                - -

                                Enumeration LocalAuthenticationLevel

                                -
                                -
                                -
                                -

                                - Used for Android only: The level of local - authentication required to access the credentials. Defaults to - LocalAuthenticationLevel.strong. -

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

                                Enumeration Members

                                -
                                - - deviceCredential - - strong - - weak -
                                -
                                -
                                -
                                -
                                -
                                -
                                - - -

                                Enumeration Members

                                -                                 -
                                -
                                - -
                                - deviceCredential: - 2 -
                                -
                                -

                                - The non-biometric credential used to secure the device (i. e. - PIN, pattern, or password). -

                                -
                                -
                                - -
                                -
                                - -
                                - strong: - 0 -
                                -
                                -

                                - Any biometric (e.g. fingerprint, iris, or face) on the device - that meets or exceeds the requirements for Class 3 (formerly - Strong), as defined by the Android CDD. -

                                -
                                -
                                - -
                                -
                                - -
                                - weak: - 1 -
                                -
                                -

                                - Any biometric (e.g. fingerprint, iris, or face) on the device - that meets or exceeds the requirements for Class 2 (formerly - Weak), as defined by the Android CDD. -

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

                                Settings

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

                                On This Page

                                -                                 -
                                -
                                - - Enumeration Members - - -
                                -
                                -
                                -
                                -
                                - -
                                -
                                -
                                -
                                -

                                - Generated using - TypeDoc -

                                -
                                -
                                - - +LocalAuthenticationLevel | react-native-auth0
                                react-native-auth0
                                  Preparing search index...

                                  Enumeration LocalAuthenticationLevel

                                  Used for Android only: The level of local authentication required to access the credentials. Defaults to LocalAuthenticationLevel.strong.

                                  +
                                  Index

                                  Enumeration Members

                                  deviceCredential +strong +weak +

                                  Enumeration Members

                                  deviceCredential: 2

                                  The non-biometric credential used to secure the device (i. e. PIN, pattern, or password).

                                  +
                                  strong: 0

                                  Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for Class 3 (formerly Strong), as defined by the Android CDD.

                                  +
                                  weak: 1

                                  Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for Class 2 (formerly Weak), as defined by the Android CDD.

                                  +

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Enumeration Members
                                  diff --git a/docs/enums/LocalAuthenticationStrategy.html b/docs/enums/LocalAuthenticationStrategy.html index 529ee3c5..b6061f87 100644 --- a/docs/enums/LocalAuthenticationStrategy.html +++ b/docs/enums/LocalAuthenticationStrategy.html @@ -1,417 +1,6 @@ - - - - - - LocalAuthenticationStrategy | react-native-auth0 - - - - - - - - - - - - -
                                  -
                                  - react-native-auth0 - - - - -
                                    -
                                    -
                                    Preparing search index...
                                    -
                                    -                                     - -
                                    -
                                    -
                                    -
                                    -
                                    - -

                                    Enumeration LocalAuthenticationStrategy

                                    -
                                    -
                                    -
                                    -

                                    - Used for iOS only: The evaluation policy to use - when accessing the credentials. Defaults to - LocalAuthenticationStrategy.deviceOwnerWithBiometrics. -

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

                                    Enumeration Members

                                    -
                                    - - deviceOwner - - deviceOwnerWithBiometrics -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - - -

                                    Enumeration Members

                                    -                                     -
                                    -
                                    - -
                                    - deviceOwner: - 2 -
                                    -
                                    -

                                    - User authentication with biometry, Apple Watch, or the device - passcode. -

                                    -
                                    -
                                    - -
                                    -
                                    - -
                                    - deviceOwnerWithBiometrics: - 1 -
                                    -
                                    -

                                    User authentication with biometry.

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

                                    Settings

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

                                    On This Page

                                    -                                     -
                                    -
                                    - - Enumeration Members - - -
                                    -
                                    -
                                    -
                                    -
                                    - -
                                    -
                                    -
                                    -
                                    -

                                    - Generated using - TypeDoc -

                                    -
                                    -
                                    - - +LocalAuthenticationStrategy | react-native-auth0
                                    react-native-auth0
                                      Preparing search index...

                                      Enumeration LocalAuthenticationStrategy

                                      Used for iOS only: The evaluation policy to use when accessing the credentials. Defaults to LocalAuthenticationStrategy.deviceOwnerWithBiometrics.

                                      +
                                      Index

                                      Enumeration Members

                                      deviceOwner +deviceOwnerWithBiometrics +

                                      Enumeration Members

                                      deviceOwner: 2

                                      User authentication with biometry, Apple Watch, or the device passcode.

                                      +
                                      deviceOwnerWithBiometrics: 1

                                      User authentication with biometry.

                                      +

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Enumeration Members
                                      diff --git a/docs/enums/SafariViewControllerPresentationStyle.html b/docs/enums/SafariViewControllerPresentationStyle.html index a1c3fbff..22546608 100644 --- a/docs/enums/SafariViewControllerPresentationStyle.html +++ b/docs/enums/SafariViewControllerPresentationStyle.html @@ -1,766 +1,13 @@ - - - - - - SafariViewControllerPresentationStyle | react-native-auth0 - - - - - - - - - - - - -
                                      -
                                      - react-native-auth0 - - - - -
                                        -
                                        -
                                        Preparing search index...
                                        -
                                        -                                         - -
                                        -
                                        -
                                        -
                                        -
                                        - -

                                        Enumeration SafariViewControllerPresentationStyle

                                        -
                                        -
                                        -
                                        -

                                        - Presentation styles for when using SFSafariViewController on iOS. - For the full description of what each option does, please see - <a href="https://developer.apple.com/documentation/uikit/uimodalpresentationstyle">https://developer.apple.com/documentation/uikit/uimodalpresentationstyle&lt;/a&gt; for more details -

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

                                        Enumeration Members

                                        -
                                        - - automatic - - currentContext - - custom - - formSheet - - fullScreen - - none - - overCurrentContext - - overFullScreen - - pageSheet - - popover -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        - - -

                                        Enumeration Members

                                        -                                         -
                                        -
                                        - -
                                        - automatic: - -2 -
                                        - -
                                        -
                                        - -
                                        - currentContext: - 3 -
                                        - -
                                        -
                                        - -
                                        - custom: - 4 -
                                        - -
                                        -
                                        - -
                                        - formSheet: - 2 -
                                        - -
                                        -
                                        - -
                                        - fullScreen: - 0 -
                                        - -
                                        -
                                        - -
                                        - none: - -1 -
                                        - -
                                        -
                                        - -
                                        - overCurrentContext: - 6 -
                                        - -
                                        -
                                        - -
                                        - overFullScreen: - 5 -
                                        - -
                                        -
                                        - -
                                        - pageSheet: - 1 -
                                        - -
                                        -
                                        - -
                                        - popover: - 7 -
                                        - -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        - - -

                                        Settings

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

                                        On This Page

                                        -                                         -
                                        -
                                        - - Enumeration Members - - -
                                        -
                                        -
                                        -
                                        -
                                        - -
                                        -
                                        -
                                        -
                                        -

                                        - Generated using - TypeDoc -

                                        -
                                        -
                                        - - +SafariViewControllerPresentationStyle | react-native-auth0
                                        react-native-auth0
                                          Preparing search index...

                                          Enumeration SafariViewControllerPresentationStyle

                                          Presentation styles for when using SFSafariViewController on iOS. +For the full description of what each option does, please see <a href="https://developer.apple.com/documentation/uikit/uimodalpresentationstyle">https://developer.apple.com/documentation/uikit/uimodalpresentationstyle&lt;/a&gt; for more details

                                          +
                                          Index

                                          Enumeration Members

                                          automatic +currentContext +custom +formSheet +fullScreen +none +overCurrentContext +overFullScreen +pageSheet +popover +

                                          Enumeration Members

                                          automatic: -2
                                          currentContext: 3
                                          custom: 4
                                          formSheet: 2
                                          fullScreen: 0
                                          none: -1
                                          overCurrentContext: 6
                                          overFullScreen: 5
                                          pageSheet: 1
                                          popover: 7

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Enumeration Members
                                          diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 2c739439..9c3e733f 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -1,490 +1,6 @@ - - - - - - Auth0Provider | react-native-auth0 - - - - - - - - - - - - -
                                          -
                                          - react-native-auth0 - - - - -
                                            -
                                            -
                                            Preparing search index...
                                            -
                                            -                                             - -
                                            -
                                            -
                                            -
                                            -
                                            - -

                                            Function Auth0Provider

                                            -
                                            -
                                            -
                                              -
                                            • - -
                                              -
                                              -

                                              Provides the Auth0Context to its child components.

                                              -
                                              -
                                              -

                                              Parameters

                                              -
                                                -
                                              • - __namedParameters: - PropsWithChildren<
                                                    {
                                                        clientId: - string;
                                                        domain: - string;
                                                        localAuthenticationOptions?: - LocalAuthenticationOptions;
                                                        timeout?: - number;
                                                    },
                                                >                                                 -
                                                • -
                                              -
                                              -

                                              - Returns Element -

                                              -
                                              -
                                              - - 
                                              &lt;Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"&gt;
                                                &lt;App /&gt;
                                              &lt;/Auth0Provider&gt;
+Auth0Provider | react-native-auth0
                                              react-native-auth0
                                                Preparing search index...
                                                Function Auth0Provider
                                                • Provides the Auth0Context to its child components.
                                                  
+
                                                  Parameters
                                                  Returns Element
                                                  &lt;Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"&gt;
                                                    &lt;App /&gt;
                                                  &lt;/Auth0Provider&gt;
 
                                                  
-                  
                                                  
-                
                                                  
-                
-              
                                                  
-            
                                                  • 
-          
                                                
-        
                                                
-        
                                                
-          
                                                
-            
                                                
-              
-                
-                
                                                Index
                                                
-                                                              
-              
                                                
-                
                                                
-                  
                                                Properties
                                                
-                  
                                                
-                    
-                        propTypes
-                  
                                                
-                
                                                
-              
                                                
-            
                                                
-          
                                                
-        
                                                
-        
                                                
-          
-            
-            
                                                Properties
                                                
-                                                          
-          
                                                
-            
                                                
-              
-              
                                                
-                propTypes:
-                {
                                                    children:
-                Validator<ReactElementLike>;
                                                    clientId:
-                Validator<string>;
                                                    domain:
-                Validator<string>;
                                                }
-              
                                                
-              
-            
                                                
-          
                                                
-        
                                                
-      
                                                
-      
                                                
-        
                                                
-          
                                                
-            
                                                
-              
-                
-                
                                                Settings
                                                
-                                                              
-              
                                                
-                
                                                
-                  Member Visibility
-                  
                                                  
-                    
                                                • 
-                      
-                    
                                                  • 
-                    
                                                • 
-                      
-                    
                                                  • 
-                  
                                                
-                
                                                
-                
                                                
-                  
-                
                                                
-              
                                                
-            
                                                
-          
                                                
-          
                                                
-            
-              
-              
                                                On This Page
                                                
-                                                            
-            
                                                
-              
                                                
-                
-                  Properties
-                
-                
-              
                                                
-            
                                                
-          
                                                
-        
                                                
-        
                                                
-          
-        
                                                
-      
                                                
-    
                                                
-    
                                                
-      
                                                
-        Generated using
-        TypeDoc
-      
                                                
-    
                                                
-    
                                                
-  
-
+
+
                                              Index

                                              Properties

                                              propTypes +

                                              Properties

                                              propTypes: {
                                                  children: Validator<ReactElementLike>;
                                                  clientId: Validator<string>;
                                                  domain: Validator<string>;
                                                  headers: Requireable<object>;
                                              }

                                              Settings

                                              Member Visibility

                                              On This Page

                                              Properties
                                              diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 0cb8d5dc..310a8fff 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -1,280 +1,7 @@ - - - - - - useAuth0 | react-native-auth0 - - - - - - - - - - - - -
                                              -
                                              - react-native-auth0 - - - - -
                                                -
                                                -
                                                Preparing search index...
                                                -
                                                -                                                 - -
                                                -
                                                -
                                                -
                                                -
                                                - -

                                                Function useAuth0

                                                -
                                                -
                                                -
                                                  -
                                                • - -
                                                  -
                                                  -

                                                  - Use the useAuth0 in your function components to - access authentication state and methods. -

                                                  -
                                                  -

                                                  - Returns - Auth0ContextInterface<User> -

                                                  -

                                                  The useAuth0 hook interface

                                                  - 
                                                  const {
                                                    // State
                                                    error,
                                                    user,
                                                    isLoading,
                                                    // Methods
                                                    authorize,
                                                    sendSMSCode,
                                                    authorizeWithSMS,
                                                    sendEmailCode,
                                                    authorizeWithEmail,
                                                    sendMultifactorChallenge,
                                                    authorizeWithOOB,
                                                    authorizeWithOTP,
                                                    authorizeWithRecoveryCode,
                                                    hasValidCredentials,
                                                    clearSession,
                                                    getCredentials,
                                                    clearCredentials,
                                                    requireLocalAuthentication,
                                                    authorizeWithPasswordRealm,
                                                    authorizeWithExchangeNativeSocial,
                                                    revokeRefreshToken
                                                  } = useAuth0();
+useAuth0 | react-native-auth0
                                                  react-native-auth0
                                                    Preparing search index...
                                                    Function useAuth0
                                                    • Use the useAuth0 in your function components to access authentication state and methods.
                                                      
+
                                                      Returns Auth0ContextInterface<User>
                                                      The useAuth0 hook interface
                                                      
+
                                                      const {
                                                        // State
                                                        error,
                                                        user,
                                                        isLoading,
                                                        // Methods
                                                        authorize,
                                                        sendSMSCode,
                                                        authorizeWithSMS,
                                                        sendEmailCode,
                                                        authorizeWithEmail,
                                                        sendMultifactorChallenge,
                                                        authorizeWithOOB,
                                                        authorizeWithOTP,
                                                        authorizeWithRecoveryCode,
                                                        hasValidCredentials,
                                                        clearSession,
                                                        getCredentials,
                                                        clearCredentials,
                                                        requireLocalAuthentication,
                                                        authorizeWithPasswordRealm,
                                                        authorizeWithExchangeNativeSocial,
                                                        revokeRefreshToken
                                                      } = useAuth0();
 
                                                      
 
-                
                                                      
-                  Refer to <a
-                  href="../interfaces/Types.Auth0ContextInterface.html"
-                  class="tsd-kind-interface">Auth0ContextInterface</a>
-                  on how to use the above methods.
-                
                                                      
-                
                                                      
-                
-              
                                                      
-            
                                                      • 
-          
                                                    
-        
                                                    
-      
                                                    
-      
                                                    
-        
                                                    
-          
                                                    
-            
                                                    
-              
-                
-                
                                                    Settings
                                                    
-                                                                  
-              
                                                    
-                
                                                    
-                  Member Visibility
-                  
                                                      
-                    
                                                    • 
-                      
-                    
                                                      • 
-                    
                                                    • 
-                      
-                    
                                                      • 
-                  
                                                    
-                
                                                    
-                
                                                    
-                  
-                
                                                    
-              
                                                    
-            
                                                    
-          
                                                    
-        
                                                    
-        
                                                    
-          
-        
                                                    
-      
                                                    
-    
                                                    
-    
                                                    
-      
                                                    
-        Generated using
-        TypeDoc
-      
                                                    
-    
                                                    
-    
                                                    
-  
-
+
                                                    Refer to <a href="../interfaces/Types.Auth0ContextInterface.html" class="tsd-kind-interface">Auth0ContextInterface</a> on how to use the above methods.
                                                    
+

                                                  Settings

                                                  Member Visibility
                                                  diff --git a/docs/hierarchy.html b/docs/hierarchy.html index 7c06f82b..a10b8b89 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,253 +1 @@ - - - - - - react-native-auth0 - - - - - - - - - - - - -
                                                  -
                                                  - react-native-auth0 - - - - -
                                                    -
                                                    -
                                                    Preparing search index...
                                                    -
                                                    -                                                     - -
                                                    -
                                                    -
                                                    -
                                                    -

                                                    react-native-auth0

                                                    -

                                                    Hierarchy Summary

                                                    - - -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -

                                                    Settings

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

                                                    - Generated using - TypeDoc -

                                                    -
                                                    -
                                                    - - +react-native-auth0
                                                    react-native-auth0
                                                      Preparing search index...

                                                      react-native-auth0

                                                      Hierarchy Summary

                                                      Settings

                                                      Member Visibility
                                                      diff --git a/docs/index.html b/docs/index.html index 8d063166..8c1bc97d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,342 +1,56 @@ - - - - - - react-native-auth0 - - - - - - - - - - - - -
                                                      -
                                                      - react-native-auth0 - - - - -
                                                        -
                                                        -
                                                        Preparing search index...
                                                        -
                                                        -                                                         - -
                                                        -
                                                        -
                                                        -
                                                        -

                                                        react-native-auth0

                                                        -
                                                        -

                                                        - react-native-auth0 -

                                                        -

                                                        - Build Status - NPM version - Coverage - License - Downloads - FOSSA Status -

                                                        -

                                                        - 📚 Documentation • 🚀 - Getting Started • ⏭️ - Next Steps • ❓ - FAQs - • ❓ Feedback -

                                                        - -

                                                        - We're excited to announce the release of react-native-auth0 - v4.0.0! Please note that this update includes breaking - changes that require your attention. To ensure a smooth transition, - please review our 👉 - Migration Guide - 👈 for detailed instructions on updating your integration. -

                                                        - - - - -

                                                        - This SDK targets apps that are using React Native SDK version - 0.65.0 and up. If you're using an older React Native - version, see the compatibility matrix below. -

                                                        - -

                                                        - The following shows platform minimums for running projects with this - SDK: -

                                                        - - - - - - - - - - - - - - - - - -
                                                        PlatformMinimum version
                                                        iOS13.0
                                                        Android34
                                                        -

                                                        - Our SDK requires a minimum iOS deployment target of 13.0. In your - project's ios/Podfile, ensure your platform target is set to 13.0. -

                                                        - 
                                                        platform :ios, '13.0'
+react-native-auth0
                                                        react-native-auth0
                                                          Preparing search index...
                                                          react-native-auth0
                                                          react-native-auth0
                                                          
+
                                                          Build Status
+NPM version
+Coverage
+License
+Downloads
+FOSSA Status
                                                          
+
                                                          📚 Documentation • 🚀 Getting Started • ⏭️ Next Steps • ❓ FAQs • ❓ Feedback
                                                          
+
                                                          We're excited to announce the release of react-native-auth0 v4.0.0! Please note that this update includes breaking changes that require your attention. To ensure a smooth transition, please review our
+👉 Migration Guide 👈 for detailed instructions on updating your integration.
                                                          
+
+
                                                          This SDK targets apps that are using React Native SDK version 0.65.0 and up. If you're using an older React Native version, see the compatibility matrix below.
                                                          
+
                                                          The following shows platform minimums for running projects with this SDK:
                                                          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                          PlatformMinimum version
                                                          iOS13.0
                                                          Android34
                                                          
+
                                                          Our SDK requires a minimum iOS deployment target of 13.0. In your project's ios/Podfile, ensure your platform target is set to 13.0.
                                                          
+
                                                          platform :ios, '13.0'
 
                                                          
 
-          
-          
                                                          First install the native library module:
                                                          
-          
-          
                                                          $ npm install react-native-auth0 --save
                                                          
-          
-          
                                                          $ yarn add react-native-auth0
                                                          
-          
                                                          
-            Then, you need to run the following command to install the ios app
-            pods with Cocoapods. That will auto-link the iOS library:
-          
                                                          
-          
                                                          $ cd ios && pod install
                                                          
-          
-          
                                                          
-            You need to make your Android, iOS or Expo applications aware that
-            an authentication result will be received from the browser. This SDK
-            makes use of the Android's Package Name and its analogous iOS's
-            Product Bundle Identifier to generate the redirect URL. Each
-            platform has its own set of instructions.
-          
                                                          
-          
-          
                                                          
-            > Before version 2.9.0, this SDK required you to add an intent
-            filter to the Activity on which you're going to receive the
-            authentication result, and to use the singleTask
-            launchMode in that activity. To migrate your app to
-            version 2.9.0+, remove both and continue with the
-            instructions below. > You can also check out a sample migration
-            diff
-            here.
-          
                                                          
-          
                                                          
-            Open your app's build.gradle file (typically at
-            android/app/build.gradle) and add the following
-            manifest placeholders:
-          
                                                          
-          
                                                          android {
+
                                                          First install the native library module:
                                                          
+
                                                          $ npm install react-native-auth0 --save
                                                          
+
                                                          $ yarn add react-native-auth0
                                                          
+
                                                          Then, you need to run the following command to install the ios app pods with Cocoapods. That will auto-link the iOS library:
                                                          
+
                                                          $ cd ios && pod install
                                                          
+
                                                          You need to make your Android, iOS or Expo applications aware that an authentication result will be received from the browser. This SDK makes use of the Android's Package Name and its analogous iOS's Product Bundle Identifier to generate the redirect URL. Each platform has its own set of instructions.
                                                          
+
                                                          > Before version 2.9.0, this SDK required you to add an intent filter to the Activity on which you're going to receive the authentication result, and to use the singleTask launchMode in that activity. To migrate your app to version 2.9.0+, remove both and continue with the instructions below.
+> You can also check out a sample migration diff here.
                                                          
+
                                                          Open your app's build.gradle file (typically at android/app/build.gradle) and add the following manifest placeholders:
                                                          
+
                                                          android {
     defaultConfig {
         // Add the next line
         manifestPlaceholders = [auth0Domain: "YOUR_AUTH0_DOMAIN", auth0Scheme: "${applicationId}.auth0"]
@@ -345,12 +59,8 @@ 
                                                          
 
-          
                                                          
-            The auth0Domain value must be replaced with your Auth0
-            domain value. So if you have samples.us.auth0.com as
-            your Auth0 domain you would have a configuration like the following:
-          
                                                          
-          
                                                          android {
+
                                                          The auth0Domain value must be replaced with your Auth0 domain value. So if you have samples.us.auth0.com as your Auth0 domain you would have a configuration like the following:
                                                          
+
                                                          android {
     defaultConfig {
         manifestPlaceholders = [auth0Domain: "samples.us.auth0.com", auth0Scheme: "${applicationId}.auth0"]
     }
@@ -358,65 +68,14 @@ 
                                                          
 
-          
                                                          
-            The applicationId value will be auto-replaced at
-            runtime with the package name or ID of your application (e.g.
-            com.example.app). You can change this value from the
-            build.gradle file. You can also check it at the top of
-            your AndroidManifest.xml file.
-          
                                                          
-          
                                                          
-            > Note that if your Android application is using
-            product flavors, you might need to specify different manifest placeholders for
-            each flavor.
-          
                                                          
-          
                                                          
-            If you use a value other than applicationId in
-            auth0Scheme you will also need to pass it as the
-            customScheme option parameter of the
-            authorize and clearSession methods.
-          
                                                          
-          
                                                          
-            Take note of this value as you'll be requiring it to define the
-            callback URLs below.
-          
                                                          
-          
                                                          
-            > For more info please read the
-            React Native docs.
-          
                                                          
-          
-          
                                                          
-            If you don't plan to use Web Authentication, you will notice that
-            the compiler will still prompt you to provide the
-            manifestPlaceholders values, since the
-            RedirectActivity included in this library will require
-            them, and the Gradle tasks won't be able to run without them.
-          
                                                          
-          
                                                          
-            Re-declare the activity manually with
-            tools:node="remove" in your app's Android
-            Manifest in order to make the manifest merger remove it from the
-            final manifest file. Additionally, one more unused activity can be
-            removed from the final APK by using the same process. A complete
-            snippet to achieve this is:
-          
                                                          
-          
                                                          <activity
+
                                                          The applicationId value will be auto-replaced at runtime with the package name or ID of your application (e.g. com.example.app). You can change this value from the build.gradle file. You can also check it at the top of your AndroidManifest.xml file.
                                                          
+
                                                          > Note that if your Android application is using product flavors, you might need to specify different manifest placeholders for each flavor.
                                                          
+
                                                          If you use a value other than applicationId in auth0Scheme you will also need to pass it as the customScheme option parameter of the authorize and clearSession methods.
                                                          
+
                                                          Take note of this value as you'll be requiring it to define the callback URLs below.
                                                          
+
                                                          > For more info please read the React Native docs.
                                                          
+
                                                          If you don't plan to use Web Authentication, you will notice that the compiler will still prompt you to provide the manifestPlaceholders values, since the RedirectActivity included in this library will require them, and the Gradle tasks won't be able to run without them.
                                                          
+
                                                          Re-declare the activity manually with tools:node="remove" in your app's Android Manifest in order to make the manifest merger remove it from the final manifest file. Additionally, one more unused activity can be removed from the final APK by using the same process. A complete snippet to achieve this is:
                                                          
+
                                                          <activity
     android:name="com.auth0.android.provider.AuthenticationActivity"
     tools:node="remove"/>
 <!-- Optional: Remove RedirectActivity -->
@@ -425,17 +84,8 @@ 
                                                          
 
-          
-          
                                                          
-            Inside the ios folder find the file
-            AppDelegate.[swift|m] add the following to it:
-          
                                                          
-          
                                                          #import <React/RCTLinkingManager.h>
+
                                                          Inside the ios folder find the file AppDelegate.[swift|m] add the following to it:
                                                          
+
                                                          #import <React/RCTLinkingManager.h>
 
 - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url
             options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options
@@ -444,21 +94,13 @@ 
                                                          
 
-          
                                                          
-            Inside the ios folder open the
-            Info.plist and locate the value for
-            CFBundleIdentifier, e.g.
-          
                                                          
-          
                                                          <key>CFBundleIdentifier</key>
+
                                                          Inside the ios folder open the Info.plist and locate the value for CFBundleIdentifier, e.g.
                                                          
+
                                                          <key>CFBundleIdentifier</key>
 <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 
                                                          
 
-          
                                                          
-            and then below it register a URL type entry using the value of
-            CFBundleIdentifier as the value for
-            CFBundleURLSchemes:
-          
                                                          
-          
                                                          <key>CFBundleURLTypes</key>
+
                                                          and then below it register a URL type entry using the value of CFBundleIdentifier as the value for CFBundleURLSchemes:
                                                          
+
                                                          <key>CFBundleURLTypes</key>
 <array>
     <dict>
         <key>CFBundleTypeRole</key>
@@ -473,1383 +115,361 @@ 
                                                          
 
-          
                                                          
-            If your application is generated using the React Native CLI, the
-            default value of $(PRODUCT_BUNDLE_IDENTIFIER) matches
-            org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier). Take note of this value as you'll be requiring it to define the
-            callback URLs below. If desired, you can change its value using
-            XCode in the following way:
-          
                                                          
-          
                                                            
-            
                                                          • 
-              Open the ios/TestApp.xcodeproj file replacing
-              'TestApp' with the name of your app or run
-              xed ios from a Terminal.
-            
                                                            • 
-            
                                                          • 
-              Open your project's or desired target's
-              Build Settings tab and on the search bar at the
-              right type "Product Bundle Identifier".
-            
                                                            • 
-            
                                                          • 
-              Replace the Product Bundle Identifier value with
-              your desired application's bundle identifier name (e.g.
-              com.example.app).
-            
                                                            • 
-            
                                                          • 
-              If you've changed the project wide settings, make sure the same
-              were applied to each of the targets your app has.
-            
                                                            • 
-          
                                                          
-          
                                                          
-            If you use a value other than
-            $(PRODUCT_BUNDLE_IDENTIFIER) in the
-            CFBundleURLSchemes field of the
-            Info.plist you will also need to pass it as the
-            customScheme option parameter of the
-            authorize and clearSession methods.
-          
                                                          
-          
                                                          
-            > For more info please read the
-            React Native docs.
-          
                                                          
-          
-          
                                                          
-            > :warning: This SDK is not compatible with "Expo Go"
-            app because of custom native code. It is compatible with Custom Dev
-            Client and EAS builds
-          
                                                          
-          
                                                          
-            To use the SDK with Expo, configure the app at build time by
-            providing the domain and the
-            customScheme values through the
-            Config Plugin. To do this, add the following snippet to app.json or
-            app.config.js:
-          
                                                          
-          
                                                          {
                                                            "expo": {
                                                              ...
                                                              "plugins": [
                                                                [
                                                                  "react-native-auth0",
                                                                  {
                                                                    "domain": "YOUR_AUTH0_DOMAIN",
                                                                    "customScheme": "YOUR_CUSTOM_SCHEME"
                                                                  }
                                                                ]
                                                              ]
                                                            }
                                                          }
+
                                                          If your application is generated using the React Native CLI, the default value of $(PRODUCT_BUNDLE_IDENTIFIER) matches org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier). Take note of this value as you'll be requiring it to define the callback URLs below. If desired, you can change its value using XCode in the following way:
                                                          
+
                                                            
+
                                                          • Open the ios/TestApp.xcodeproj file replacing 'TestApp' with the name of your app or run xed ios from a Terminal.
                                                            • 
+
                                                          • Open your project's or desired target's Build Settings tab and on the search bar at the right type "Product Bundle Identifier".
                                                            • 
+
                                                          • Replace the Product Bundle Identifier value with your desired application's bundle identifier name (e.g. com.example.app).
                                                            • 
+
                                                          • If you've changed the project wide settings, make sure the same were applied to each of the targets your app has.
                                                            • 
+
                                                          
+
                                                          If you use a value other than $(PRODUCT_BUNDLE_IDENTIFIER) in the CFBundleURLSchemes field of the Info.plist you will also need to pass it as the customScheme option parameter of the authorize and clearSession methods.
                                                          
+
                                                          > For more info please read the React Native docs.
                                                          
+
                                                          > :warning: This SDK is not compatible with "Expo Go" app because of custom native code. It is compatible with Custom Dev Client and EAS builds
                                                          
+
                                                          To use the SDK with Expo, configure the app at build time by providing the domain and the customScheme values through the Config Plugin. To do this, add the following snippet to app.json or app.config.js:
                                                          
+
                                                          {
                                                            "expo": {
                                                              ...
                                                              "plugins": [
                                                                [
                                                                  "react-native-auth0",
                                                                  {
                                                                    "domain": "YOUR_AUTH0_DOMAIN",
                                                                    "customScheme": "YOUR_CUSTOM_SCHEME"
                                                                  }
                                                                ]
                                                              ]
                                                            }
                                                          }
 
                                                          
 
-          
                                                          
-            > :info: If you want to switch between multiple domains in your
-            app, refer
-            here
-          
                                                          
-          
-            
-              
-                
-                
-              
-            
-            
-              
-                
-                
-              
-              
-                
-                
-              
-            
-          
                                                          APIDescription
                                                          domain
-                  Mandatory: Provide the Auth0 domain that can be found at the
-                  Application Settings
-                
                                                          customScheme
-                  Optional: Custom scheme to build the callback URL with. The
-                  value provided here should be passed to the
-                  customScheme option parameter of the
-                  authorize and clearSession methods.
-                  The custom scheme should be a unique, all lowercase value with
-                  no special characters.
-                
                                                          
-          
                                                          
-            Now you can run the application using
-            expo run:android or expo run:ios.
-          
                                                          
-          
-          
                                                          
-            Callback URLs are the URLs that Auth0 invokes after the
-            authentication process. Auth0 routes your application back to this
-            URL and appends additional parameters to it, including a token.
-            Since callback URLs can be manipulated, you will need to add this
-            URL to your Application's Allowed Callback URLs for
-            security. This will enable Auth0 to recognize these URLs as valid.
-            If omitted, authentication will not be successful.
-          
                                                          
-          
                                                          
-            On the Android platform this URL is case-sensitive. Because of that,
-            this SDK will auto convert the Bundle Identifier (iOS) and
-            Application ID (Android) values to lowercase in order to build the
-            Callback URL with them. If any of these values contains uppercase
-            characters a warning message will be printed in the console. Make
-            sure to check that the right Callback URL is whitelisted in the
-            Auth0 dashboard or the browser will not route successfully back to
-            your application.
-          
                                                          
-          
                                                          
-            Go to the
-            Auth0 Dashboard, select your application and make sure that
-            Allowed Callback URLs contains the URLs defined
-            below.
-          
                                                          
-          
                                                          
-            If in addition you plan to use the log out method, you must also add
-            these URLs to the Allowed Logout URLs.
-          
                                                          
-          
                                                          
-            > [!NOTE] > Whenever possible, Auth0 recommends using
-            Android App Links
-            and
-            Apple Universal Links
-            for your callback and logout URLs. Custom URL schemes can be subject
-            to
-            client impersonation attacks. > > 💡 If your Android app is using
-            product flavors, you might need to specify different manifest placeholders for
-            each flavor.
-          
                                                          
-          
-          
-          
                                                          {YOUR_APP_PACKAGE_NAME}.auth0://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+
                                                          > :info: If you want to switch between multiple domains in your app, refer here
                                                          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                          APIDescription
                                                          domainMandatory: Provide the Auth0 domain that can be found at the Application Settings
                                                          customSchemeOptional: Custom scheme to build the callback URL with. The value provided here should be passed to the customScheme option parameter of the authorize and clearSession methods. The custom scheme should be a unique, all lowercase value with no special characters.
                                                          
+
                                                          Now you can run the application using expo run:android or expo run:ios.
                                                          
+
                                                          Callback URLs are the URLs that Auth0 invokes after the authentication process. Auth0 routes your application back to this URL and appends additional parameters to it, including a token. Since callback URLs can be manipulated, you will need to add this URL to your Application's Allowed Callback URLs for security. This will enable Auth0 to recognize these URLs as valid. If omitted, authentication will not be successful.
                                                          
+
                                                          On the Android platform this URL is case-sensitive. Because of that, this SDK will auto convert the Bundle Identifier (iOS) and Application ID (Android) values to lowercase in order to build the Callback URL with them. If any of these values contains uppercase characters a warning message will be printed in the console. Make sure to check that the right Callback URL is whitelisted in the Auth0 dashboard or the browser will not route successfully back to your application.
                                                          
+
                                                          Go to the Auth0 Dashboard, select your application and make sure that Allowed Callback URLs contains the URLs defined below.
                                                          
+
                                                          If in addition you plan to use the log out method, you must also add these URLs to the Allowed Logout URLs.
                                                          
+
                                                          > [!NOTE]
+> Whenever possible, Auth0 recommends using Android App Links and Apple Universal Links for your callback and logout URLs. Custom URL schemes can be subject to client impersonation attacks.
+>
+> 💡 If your Android app is using product flavors, you might need to specify different manifest placeholders for each flavor.
                                                          
+
                                                          {YOUR_APP_PACKAGE_NAME}.auth0://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
 
                                                          
 
-          
-          
                                                          https://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+
                                                          https://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
 
                                                          
 
-          
                                                          
-            > Replace {YOUR_APP_PACKAGE_NAME} and {YOUR_AUTH0_DOMAIN} with
-            your actual application package name and Auth0 domain. Ensure that
-            {YOUR_APP_PACKAGE_NAME} is all lowercase.
-          
                                                          
-          
                                                          
-            To enable App Links, set the auth0Scheme to
-            https in your build.gradle file.
-          
                                                          
-          
                                                          android {
+
                                                          > Replace {YOUR_APP_PACKAGE_NAME} and {YOUR_AUTH0_DOMAIN} with your actual application package name and Auth0 domain. Ensure that {YOUR_APP_PACKAGE_NAME} is all lowercase.
                                                          
+
                                                          To enable App Links, set the auth0Scheme to https in your build.gradle file.
                                                          
+
                                                          android {
     defaultConfig {
         manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "https"]
     }
 }
 
                                                          
 
-          
                                                          
-            This configuration ensures that your app uses https for the callback
-            URL scheme, which is required for Android App Links.
-          
                                                          
-          
-          
                                                          
-            Android App Links
-            allow an application to designate itself as the default handler of a
-            given type of link. For example, clicking a URL in an email would
-            open the link in the designated application. This guide will show
-            you how to enable Android App links support for your
-            Auth0-registered application using Auth0's Dashboard.
-          
                                                          
-          
                                                            
-            
                                                          1. 
-              
                                                            
-                Go to
-                Auth0 Dashboard > Applications > Applications, and select the name of the application to view.
-              
                                                            
-            
                                                            2. 
-            
                                                          2. 
-              
                                                            
-                Scroll to the bottom of the Settings page, and select
-                Show Advanced Settings.
-              
                                                            
-            
                                                            3. 
-            
                                                          3. 
-              
                                                            
-                Select Device Settings, provide the
-                App Package Name and
-                the SHA256 fingerprints of your app’s signing certificate for
-                your Android application, and select Save Changes.
-                android-app-link
-              
                                                            
-            
                                                            4. 
-          
                                                          
-          
                                                          
-            > You can use the following command to generate the fingerprint
-            using the Java keytool in your terminal:
-            keytool -list -v -keystore my-release-key.keystore
-          
                                                          
-          
                                                          
-            To learn more about signing certificates, see Android's
-            Sign Your App
-            developer documentation.
-          
                                                          
-          
-          
-          
                                                          {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
+
                                                          This configuration ensures that your app uses https for the callback URL scheme, which is required for Android App Links.
                                                          
+
                                                          Android App Links allow an application to designate itself as the default handler of a given type of link. For example, clicking a URL in an email would open the link in the designated application. This guide will show you how to enable Android App links support for your Auth0-registered application using Auth0's Dashboard.
                                                          
+
                                                            
+
                                                          1. 
+
                                                            Go to Auth0 Dashboard > Applications > Applications, and select the name of the application to view.
                                                            
+
                                                            2. 
+
                                                          2. 
+
                                                            Scroll to the bottom of the Settings page, and select Show Advanced Settings.
                                                            
+
                                                            3. 
+
                                                          3. 
+
                                                            Select Device Settings, provide the App Package Name and the SHA256 fingerprints of your app’s signing certificate for your Android application, and select Save Changes.
+android-app-link
                                                            
+
                                                            4. 
+
                                                          
+
                                                          > You can use the following command to generate the fingerprint using the Java keytool in your terminal: keytool -list -v -keystore my-release-key.keystore
                                                          
+
                                                          To learn more about signing certificates, see Android's Sign Your App developer documentation.
                                                          
+
                                                          {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
 
                                                          
 
-          
-          
                                                          https://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
+
                                                          https://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
 
                                                          
 
-          
                                                          
-            > Replace {PRODUCT_BUNDLE_IDENTIFIER} and
-            {YOUR_AUTH0_DOMAIN} with your actual product bundle
-            identifier and Auth0 domain. Ensure that {PRODUCT_BUNDLE_IDENTIFIER}
-            is all lowercase.
-          
                                                          
-          
-          
                                                          
-            > [!IMPORTANT] > This step requires a paid Apple Developer
-            account. It is needed to use Universal Links as callback and logout
-            URLs. > Skip this step to use a custom URL scheme instead.
-          
                                                          
-          
-          
                                                          
-            Scroll to the end of the settings page of your Auth0 application and
-            open Advanced Settings > Device Settings. In the
-            iOS section, set Team ID to your
-            Apple Team ID, and App ID to your app's bundle identifier.
-          
                                                          
-          
                                                          
-            Screenshot of the iOS section inside the Auth0 application settings page
-          
                                                          
-          
                                                          
-            This will add your app to your Auth0 tenant's
-            apple-app-site-association file.
-          
                                                          
-          
-          
                                                          
-            In Xcode, go to the Signing and Capabilities
-            tab
-            of your app's target settings, and press the
-            + Capability button. Then select
-            Associated Domains.
-          
                                                          
-          
                                                          
-            Screenshot of the capabilities library inside Xcode
-          
                                                          
-          
                                                          
-            Next, add the following
-            entry
-            under Associated Domains:
-          
                                                          
-          
                                                          webcredentials:YOUR_AUTH0_DOMAIN
+
                                                          > Replace {PRODUCT_BUNDLE_IDENTIFIER} and {YOUR_AUTH0_DOMAIN} with your actual product bundle identifier and Auth0 domain. Ensure that {PRODUCT_BUNDLE_IDENTIFIER} is all lowercase.
                                                          
+
                                                          > [!IMPORTANT]
+> This step requires a paid Apple Developer account. It is needed to use Universal Links as callback and logout URLs.
+> Skip this step to use a custom URL scheme instead.
                                                          
+
                                                          Scroll to the end of the settings page of your Auth0 application and open Advanced Settings > Device Settings. In the iOS section, set Team ID to your Apple Team ID, and App ID to your app's bundle identifier.
                                                          
+
                                                          Screenshot of the iOS section inside the Auth0 application settings page
                                                          
+
                                                          This will add your app to your Auth0 tenant's apple-app-site-association file.
                                                          
+
                                                          In Xcode, go to the Signing and Capabilities tab of your app's target settings, and press the + Capability button. Then select Associated Domains.
                                                          
+
                                                          Screenshot of the capabilities library inside Xcode
                                                          
+
                                                          Next, add the following entry under Associated Domains:
                                                          
+
                                                          webcredentials:YOUR_AUTH0_DOMAIN
 
                                                          
 
-          
                                                          <details> <summary>Example</summary>
                                                          
-          
                                                          
-            If your Auth0 Domain were example.us.auth0.com, then
-            this value would be:
-          
                                                          
-          
                                                          webcredentials:example.us.auth0.com
+
                                                          <details>
+<summary>Example</summary>
                                                          
+
                                                          If your Auth0 Domain were example.us.auth0.com, then this value would be:
                                                          
+
                                                          webcredentials:example.us.auth0.com
 
                                                          
 
-          
                                                          </details>
                                                          
-          
                                                          
-            If you have a custom domain, replace YOUR_AUTH0_DOMAIN with your custom domain.
-          
                                                          
-          
                                                          
-            > [!NOTE] > For the associated domain to work, your app must
-            be signed with your team certificate
-            even when building for the iOS simulator. Make sure
-            you are using the Apple Team whose Team ID is configured in the
-            settings page of your Auth0 application.
-          
                                                          
-          
                                                          
-            Refer to the example of
-            Using custom scheme for web authentication redirection
-          
                                                          
-          
-          
                                                          
-            > This SDK is OIDC compliant. To ensure OIDC compliant responses
-            from the Auth0 servers enable the
-            OIDC Conformant switch in your Auth0 dashboard
-            under Application / Settings / Advanced OAuth. For more
-            information please check
-            this documentation.
-          
                                                          
-          
-          
                                                          
-            The SDK exports a React hook as the primary interface for performing
-            web authentication through the
-            browser using Auth0
-            Universal Login.
-          
                                                          
-          
                                                          
-            Use the methods from the useAuth0 hook to implement
-            login, logout, and to retrieve details about the authenticated user.
-          
                                                          
-          
                                                          
-            See the
-            API Documentation
-            for full details on the useAuth0 hook.
-          
                                                          
-          
                                                          
-            First, import the Auth0Provider component and wrap it
-            around your application. Provide the domain and
-            clientId values as given to you when setting up your
-            Auth0 app in the dashboard:
-          
                                                          
-          
                                                          import { Auth0Provider } from 'react-native-auth0';

                                                          const App = () =&gt; {
                                                            return (
                                                              &lt;Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"&gt;
                                                                {/* YOUR APP */}
                                                              &lt;/Auth0Provider&gt;
                                                            );
                                                          };

                                                          export default App;
+
                                                          </details>
                                                          
+
                                                          If you have a custom domain, replace YOUR_AUTH0_DOMAIN with your custom domain.
                                                          
+
                                                          > [!NOTE]
+> For the associated domain to work, your app must be signed with your team certificate even when building for the iOS simulator. Make sure you are using the Apple Team whose Team ID is configured in the settings page of your Auth0 application.
                                                          
+
                                                          Refer to the example of Using custom scheme for web authentication redirection
                                                          
+
                                                          > This SDK is OIDC compliant. To ensure OIDC compliant responses from the Auth0 servers enable the OIDC Conformant switch in your Auth0 dashboard under Application / Settings / Advanced OAuth. For more information please check this documentation.
                                                          
+
                                                          The SDK exports a React hook as the primary interface for performing web authentication through the browser using Auth0 Universal Login.
                                                          
+
                                                          Use the methods from the useAuth0 hook to implement login, logout, and to retrieve details about the authenticated user.
                                                          
+
                                                          See the API Documentation for full details on the useAuth0 hook.
                                                          
+
                                                          First, import the Auth0Provider component and wrap it around your application. Provide the domain and clientId values as given to you when setting up your Auth0 app in the dashboard:
                                                          
+
                                                          import { Auth0Provider } from 'react-native-auth0';

                                                          const App = () =&gt; {
                                                            return (
                                                              &lt;Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"&gt;
                                                                {/* YOUR APP */}
                                                              &lt;/Auth0Provider&gt;
                                                            );
                                                          };

                                                          export default App;
 
                                                          
 
-          
                                                          
-            <details> <summary>Using the
-            Auth0 class</summary>
-          
                                                          
-          
                                                          
-            If you're not using React Hooks, you can simply instantiate the
-            Auth0 class:
-          
                                                          
-          
                                                          import Auth0 from 'react-native-auth0';

                                                          const auth0 = new Auth0({
                                                            domain: 'YOUR_AUTH0_DOMAIN',
                                                            clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                          });
+
                                                          You can also pass custom headers that will be included in all API requests:
                                                          
+
                                                          import { Auth0Provider } from 'react-native-auth0';

                                                          const App = () =&gt; {
                                                            return (
                                                              &lt;Auth0Provider 
                                                                domain="YOUR_AUTH0_DOMAIN" 
                                                                clientId="YOUR_AUTH0_CLIENT_ID"
                                                                headers={{ 'X-Custom-Header': 'custom-value' }}
                                                              &gt;
                                                                {/* YOUR APP */}
                                                              &lt;/Auth0Provider&gt;
                                                            );
                                                          };

                                                          export default App;
 
                                                          
 
-          
                                                          </details>
                                                          
-          
                                                          
-            Then import the hook into a component where you want to get access
-            to the properties and methods for integrating with Auth0:
-          
                                                          
-          
                                                          import { useAuth0 } from 'react-native-auth0';
+
                                                          <details>
+<summary>Using the Auth0 class</summary>
                                                          
+
                                                          If you're not using React Hooks, you can simply instantiate the Auth0 class:
                                                          
+
                                                          import Auth0 from 'react-native-auth0';

                                                          const auth0 = new Auth0({
                                                            domain: 'YOUR_AUTH0_DOMAIN',
                                                            clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                          });
 
                                                          
 
-          
-          
                                                          
-            Use the authorize method to redirect the user to the
-            Auth0
-            Universal Login
-            page for authentication. If scope is not specified,
-            openid profile email is used by default.
-          
                                                          
-          
                                                            
-            
                                                          • 
-              The isLoading property is set to true once the
-              authentication state of the user is known to the SDK.
-            
                                                            • 
-            
                                                          • 
-              The user property is populated with details about the
-              authenticated user. If user is null, no
-              user is currently authenticated.
-            
                                                            • 
-            
                                                          • 
-              The error property is populated if any error occurs.
-            
                                                            • 
-          
                                                          
-          
                                                          const Component = () =&gt; {
                                                            const { authorize, user, isLoading, error } = useAuth0();

                                                            const login = async () =&gt; {
                                                              await authorize();
                                                            };

                                                            if (isLoading) {
                                                              return (
                                                                &lt;View&gt;
                                                                  &lt;Text&gt;SDK is Loading&lt;/Text&gt;
                                                                &lt;/View&gt;
                                                              );
                                                            }

                                                            return (
                                                              &lt;View&gt;
                                                                {!user && &lt;Button onPress={login} title="Log in" /&gt;}
                                                                {user && &lt;Text&gt;Logged in as {user.name}&lt;/Text&gt;}
                                                                {error && &lt;Text&gt;{error.message}&lt;/Text&gt;}
                                                              &lt;/View&gt;
                                                            );
                                                          };
+
                                                          You can also pass custom headers that will be included in all API requests:
                                                          
+
                                                          import Auth0 from 'react-native-auth0';

                                                          const auth0 = new Auth0({
                                                            domain: 'YOUR_AUTH0_DOMAIN',
                                                            clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                            headers: {
                                                              'X-Custom-Header': 'custom-value',
                                                            }
                                                          });
 
                                                          
 
-          
                                                          
-            <details> <summary>Using the
-            Auth0 class</summary>
-          
                                                          
-          
                                                          auth0.webAuth
                                                            .authorize()
                                                            .then(credentials =&gt; console.log(credentials))
                                                            .catch(error =&gt; console.log(error));
+
                                                          </details>
                                                          
+
                                                          Then import the hook into a component where you want to get access to the properties and methods for integrating with Auth0:
                                                          
+
                                                          import { useAuth0 } from 'react-native-auth0';
 
                                                          
 
-          
                                                          </details>
                                                          
-          
                                                          
-            > Web Authentication flows require a Browser application
-            installed on the device. When no Browser is available, an error of
-            type a0.browser_not_available will be raised via the
-            provided callback.
-          
                                                          
-          
-          
                                                          ios-sso-alert
                                                          
-          
                                                          
-            Check the FAQ for more information about
-            the alert box that pops up by default when using
-            Web Auth on iOS.
-          
                                                          
-          
                                                          
-            > See also
-            this blog post
-            for a detailed overview of Single Sign-On (SSO) on iOS.
-          
                                                          
-          
-          
                                                          
-            Log the user out by using the clearSession method from
-            the useAuth0 hook.
-          
                                                          
-          
                                                          const Component = () =&gt; {
                                                            const { clearSession, user } = useAuth0();

                                                            const logout = async () =&gt; {
                                                              await clearSession();
                                                            };

                                                            return &lt;View&gt;{user && &lt;Button onPress={logout} title="Log out" /&gt;}&lt;/View&gt;;
                                                          };
+
                                                          Use the authorize method to redirect the user to the Auth0 Universal Login page for authentication. If scope is not specified, openid profile email is used by default.
                                                          
+
                                                            
+
                                                          • The isLoading property is set to true once the authentication state of the user is known to the SDK.
                                                            • 
+
                                                          • The user property is populated with details about the authenticated user. If user is null, no user is currently authenticated.
                                                            • 
+
                                                          • The error property is populated if any error occurs.
                                                            • 
+
                                                          
+
                                                          const Component = () =&gt; {
                                                            const { authorize, user, isLoading, error } = useAuth0();

                                                            const login = async () =&gt; {
                                                              await authorize();
                                                            };

                                                            if (isLoading) {
                                                              return (
                                                                &lt;View&gt;
                                                                  &lt;Text&gt;SDK is Loading&lt;/Text&gt;
                                                                &lt;/View&gt;
                                                              );
                                                            }

                                                            return (
                                                              &lt;View&gt;
                                                                {!user && &lt;Button onPress={login} title="Log in" /&gt;}
                                                                {user && &lt;Text&gt;Logged in as {user.name}&lt;/Text&gt;}
                                                                {error && &lt;Text&gt;{error.message}&lt;/Text&gt;}
                                                              &lt;/View&gt;
                                                            );
                                                          };
 
                                                          
 
-          
                                                          
-            <details> <summary>Using the
-            Auth0 class</summary>
-          
                                                          
-          
                                                          auth0.webAuth.clearSession().catch((error) =&gt; console.log(error));
+
                                                          <details>
+<summary>Using the Auth0 class</summary>
                                                          
+
                                                          auth0.webAuth
                                                            .authorize()
                                                            .then(credentials =&gt; console.log(credentials))
                                                            .catch(error =&gt; console.log(error));
 
                                                          
 
-          
                                                          </details>
                                                          
-          
-          
-          
                                                          
-            The Credentials Manager allows you to securely store and retrieve
-            the user's credentials. The credentials will be stored encrypted in
-            Shared Preferences on Android, and in the Keychain on iOS.
-          
                                                          
-          
                                                          
-            The Auth0 class exposes the
-            credentialsManager property for you to interact with
-            using the API below.
-          
                                                          
-          
                                                          
-            > 💡 If you're using Web Auth (authorize) through
-            Hooks, you do not need to manually store the credentials after login
-            and delete them after logout; the SDK does this automatically.
-          
                                                          
-          
-          
                                                          
-            When the users open your app, check for valid credentials. If they
-            exist, you can retrieve them and redirect the users to the app's
-            main flow without any additional login steps.
-          
                                                          
-          
                                                          const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();

                                                          if (isLoggedIn) {
                                                            // Retrieve credentials and redirect to the main flow
                                                          } else {
                                                            // Redirect to the login page
                                                          }
+
                                                          </details>
                                                          
+
                                                          > Web Authentication flows require a Browser application installed on the device. When no Browser is available, an error of type a0.browser_not_available will be raised via the provided callback.
                                                          
+
                                                          ios-sso-alert
                                                          
+
                                                          Check the FAQ for more information about the alert box that pops up by default when using Web Auth on iOS.
                                                          
+
                                                          > See also this blog post for a detailed overview of Single Sign-On (SSO) on iOS.
                                                          
+
                                                          Log the user out by using the clearSession method from the useAuth0 hook.
                                                          
+
                                                          const Component = () =&gt; {
                                                            const { clearSession, user } = useAuth0();

                                                            const logout = async () =&gt; {
                                                              await clearSession();
                                                            };

                                                            return &lt;View&gt;{user && &lt;Button onPress={logout} title="Log out" /&gt;}&lt;/View&gt;;
                                                          };
 
                                                          
 
-          
-          
                                                          
-            The credentials will be automatically renewed using the
-            refresh token, if the access token has expired.
-            This method is thread safe.
-          
                                                          
-          
                                                          const credentials = await auth0.credentialsManager.getCredentials();
+
                                                          <details>
+<summary>Using the Auth0 class</summary>
                                                          
+
                                                          auth0.webAuth.clearSession().catch((error) =&gt; console.log(error));
 
                                                          
 
-          
                                                          
-            > 💡 You do not need to call credentialsManager.saveCredentials()
-            afterward. The Credentials Manager automatically persists the
-            renewed credentials.
-          
                                                          
-          
-          
                                                          
-            > :warning: The requireLocalAuthentication method is
-            no longer available as part of the
-            CredentialsManager class or the
-            useAuth0 Hook from v4 of the SDK.
-          
                                                          
-          
                                                          
-            > ℹ️ You need to use at least version 0.59.0 of
-            React Native, as it uses FragmentActivity as the base
-            activity, which is required for biometric authentication to work.
-          
                                                          
-          
                                                          
-            You can enable an additional level of user authentication before
-            retrieving credentials using the local authentication supported by
-            the device, for example PIN or fingerprint on Android, and Face ID
-            or Touch ID on iOS.
-          
                                                          
-          
                                                          
-            Refer to the instructions below to understand how to enable
-            authentication before retrieving credentials based on your setup:
-          
                                                          
-          
                                                          Using Auth0 Class:
                                                          
-          
                                                          
-            The Auth0 class constructor now accepts a new
-            parameter, which is an instance of the
-            LocalAuthenticationOptions object. This needs to be
-            passed while creating an instance of Auth0 to enable
-            authentication before obtaining credentials, as shown in the code
-            snippet below:
-          
                                                          
-          
                                                          import Auth0 from 'react-native-auth0';
                                                          const localAuthOptions: LocalAuthenticationOptions = {
                                                            title: 'Authenticate to retreive your credentials',
                                                            subtitle: 'Please authenticate to continue',
                                                            description: 'We need to authenticate you to retrieve your credentials',
                                                            cancelTitle: 'Cancel',
                                                            evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                            fallbackTitle: 'Use Passcode',
                                                            authenticationLevel: LocalAuthenticationLevel.strong,
                                                            deviceCredentialFallback: true,
                                                          };
                                                          const auth0 = new Auth0({
                                                            domain: config.domain,
                                                            clientId: config.clientId,
                                                            localAuthenticationOptions: localAuthOptions,
                                                          });
+
                                                          </details>
                                                          
+
+
                                                          The Credentials Manager allows you to securely store and retrieve the user's credentials. The credentials will be stored encrypted in Shared Preferences on Android, and in the Keychain on iOS.
                                                          
+
                                                          The Auth0 class exposes the credentialsManager property for you to interact with using the API below.
                                                          
+
                                                          > 💡 If you're using Web Auth (authorize) through Hooks, you do not need to manually store the credentials after login and delete them after logout; the SDK does this automatically.
                                                          
+
                                                          When the users open your app, check for valid credentials. If they exist, you can retrieve them and redirect the users to the app's main flow without any additional login steps.
                                                          
+
                                                          const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();

                                                          if (isLoggedIn) {
                                                            // Retrieve credentials and redirect to the main flow
                                                          } else {
                                                            // Redirect to the login page
                                                          }
 
                                                          
 
-          
                                                          Using Hooks (Auth0Provider):
                                                          
-          
                                                          
-            Auth0Provider now accepts a new parameter, which is an
-            instance of the LocalAuthenticationOptions object. This
-            needs to be passed to enable authentication before obtaining
-            credentials, as shown in the code snippet below:
-          
                                                          
-          
                                                          import { Auth0Provider } from 'react-native-auth0';

                                                          const localAuthOptions: LocalAuthenticationOptions = {
                                                            title: 'Authenticate to retreive your credentials',
                                                            subtitle: 'Please authenticate to continue',
                                                            description: 'We need to authenticate you to retrieve your credentials',
                                                            cancelTitle: 'Cancel',
                                                            evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                            fallbackTitle: 'Use Passcode',
                                                            authenticationLevel: LocalAuthenticationLevel.strong,
                                                            deviceCredentialFallback: true,
                                                          };

                                                          const App = () =&gt; {
                                                            return (
                                                              &lt;Auth0Provider
                                                                domain={config.domain}
                                                                clientId={config.clientId}
                                                                localAuthenticationOptions={localAuthOptions}
                                                              &gt;
                                                                {/* YOUR APP */}
                                                              &lt;/Auth0Provider&gt;
                                                            );
                                                          };

                                                          export default App;
+
                                                          The credentials will be automatically renewed using the refresh token, if the access token has expired. This method is thread safe.
                                                          
+
                                                          const credentials = await auth0.credentialsManager.getCredentials();
 
                                                          
 
-          
                                                          
-            Detailed information on LocalAuthenticationOptions is
-            available here
-          
                                                          
-          
                                                          LocalAuthenticationOptions:
                                                          
-          
                                                          
-            The options for configuring the display of local authentication
-            prompt, authentication level (Android only), and evaluation policy
-            (iOS only).
-          
                                                          
-          
                                                          Properties:
                                                          
-          
-            
-              
-                
-                
-                
-                
-              
-            
-            
-              
-                
-                
-                
-                
-              
-              
-                
-                
-                
-                
-              
-              
-                
-                
-                
-                
-              
-              
-                
-                
-                
-                
-              
-              
-                
-                
-                
-                
-              
-              
-                
-                
-                
-                
-              
-              
-                
-                
-                
-                
-              
-              
-                
-                
-                
-                
-              
-            
-          
                                                          PropertyTypeDescriptionApplicable Platforms
                                                          titleStringThe title of the authentication prompt.Android, iOS
                                                          subtitleString (optional)The subtitle of the authentication prompt.Android
                                                          descriptionString (optional)The description of the authentication prompt.Android
                                                          cancelTitleString (optional)The cancel button title of the authentication prompt.Android, iOS
                                                          evaluationPolicyLocalAuthenticationStrategy (optional)
-                  The evaluation policy to use when prompting the user for
-                  authentication. Defaults to
-                  deviceOwnerWithBiometrics.
-                iOS
                                                          fallbackTitleString (optional)The fallback button title of the authentication prompt.iOS
                                                          authenticationLevelLocalAuthenticationLevel (optional)
-                  The authentication level to use when prompting the user for
-                  authentication. Defaults to strong.
-                Android
                                                          deviceCredentialFallbackBoolean (optional)
-                  Should the user be given the option to authenticate with their
-                  device PIN, pattern, or password instead of a biometric.
-                  Defaults to false
-                Android
                                                          
-          
                                                          
-            > :warning: You need a real device to test Local Authentication
-            for iOS. Local Authentication is not available in simulators.
-          
                                                          
-          
-          
                                                          
-            The Credentials Manager will only throw
-            CredentialsManagerError exceptions. You can find more
-            information in the details property of the exception.
-          
                                                          
-          
                                                          try {
                                                            const credentials = await auth0.credentialsManager.getCredentials();
                                                          } catch (error) {
                                                            console.log(error);
                                                          }
+
                                                          > 💡 You do not need to call credentialsManager.saveCredentials() afterward. The Credentials Manager automatically persists the renewed credentials.
                                                          
+
                                                          > :warning: The requireLocalAuthentication method is no longer available as part of the CredentialsManager class or the useAuth0 Hook from v4 of the SDK.
                                                          
+
                                                          > ℹ️ You need to use at least version 0.59.0 of React Native, as it uses FragmentActivity as the base activity, which is required for biometric authentication to work.
                                                          
+
                                                          You can enable an additional level of user authentication before retrieving credentials using the local authentication supported by the device, for example PIN or fingerprint on Android, and Face ID or Touch ID on iOS.
                                                          
+
                                                          Refer to the instructions below to understand how to enable authentication before retrieving credentials based on your setup:
                                                          
+
                                                          Using Auth0 Class:
                                                          
+
                                                          The Auth0 class constructor now accepts a new parameter, which is an instance of the LocalAuthenticationOptions object. This needs to be passed while creating an instance of Auth0 to enable authentication before obtaining credentials, as shown in the code snippet below:
                                                          
+
                                                          import Auth0 from 'react-native-auth0';
                                                          const localAuthOptions: LocalAuthenticationOptions = {
                                                            title: 'Authenticate to retreive your credentials',
                                                            subtitle: 'Please authenticate to continue',
                                                            description: 'We need to authenticate you to retrieve your credentials',
                                                            cancelTitle: 'Cancel',
                                                            evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                            fallbackTitle: 'Use Passcode',
                                                            authenticationLevel: LocalAuthenticationLevel.strong,
                                                            deviceCredentialFallback: true,
                                                          };
                                                          const auth0 = new Auth0({
                                                            domain: config.domain,
                                                            clientId: config.clientId,
                                                            localAuthenticationOptions: localAuthOptions,
                                                          });
 
                                                          
 
-          
                                                          Platform agnostic errors:
                                                          
-          
                                                          
-            You can access the platform agnostic generic error codes as below :
-          
                                                          
-          
                                                          try {
                                                            const credentials = await auth0.credentialsManager.getCredentials();
                                                          } catch (error) {
                                                            console.log(e.type);
                                                          }
+
                                                          Using Hooks (Auth0Provider):
                                                          
+
                                                          Auth0Provider now accepts a new parameter, which is an instance of the LocalAuthenticationOptions object. This needs to be passed to enable authentication before obtaining credentials, as shown in the code snippet below:
                                                          
+
                                                          import { Auth0Provider } from 'react-native-auth0';

                                                          const localAuthOptions: LocalAuthenticationOptions = {
                                                            title: 'Authenticate to retreive your credentials',
                                                            subtitle: 'Please authenticate to continue',
                                                            description: 'We need to authenticate you to retrieve your credentials',
                                                            cancelTitle: 'Cancel',
                                                            evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                            fallbackTitle: 'Use Passcode',
                                                            authenticationLevel: LocalAuthenticationLevel.strong,
                                                            deviceCredentialFallback: true,
                                                          };

                                                          const App = () =&gt; {
                                                            return (
                                                              &lt;Auth0Provider
                                                                domain={config.domain}
                                                                clientId={config.clientId}
                                                                localAuthenticationOptions={localAuthOptions}
                                                              &gt;
                                                                {/* YOUR APP */}
                                                              &lt;/Auth0Provider&gt;
                                                            );
                                                          };

                                                          export default App;
 
                                                          
 
-          
                                                          
-            Note : We have platform agnostic error codes available only
-            for CredentialsManagerError as of now.
-          
                                                          
-          
-            
-              
-                
-                
-                
-              
-            
-            
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-              
-                
-                
-                
-              
-            
-          
                                                          Generic Error CodeCorresponding Error Code in AndroidCorresponding Error Code in iOS
                                                          INVALID_CREDENTIALSINVALID_CREDENTIALS
                                                          NO_CREDENTIALSNO_CREDENTIALSnoCredentials
                                                          NO_REFRESH_TOKENNO_REFRESH_TOKENnoRefreshToken
                                                          RENEW_FAILEDRENEW_FAILEDrenewFailed
                                                          STORE_FAILEDSTORE_FAILEDstoreFailed
                                                          REVOKE_FAILEDREVOKE_FAILEDrevokeFailed
                                                          LARGE_MIN_TTLLARGE_MIN_TTLlargeMinTTL
                                                          INCOMPATIBLE_DEVICEINCOMPATIBLE_DEVICE
                                                          CRYPTO_EXCEPTIONCRYPTO_EXCEPTION
                                                          BIOMETRICS_FAILED
-                  OneOf
-                  <br>BIOMETRIC_NO_ACTIVITY,BIOMETRIC_ERROR_STATUS_UNKNOWN,BIOMETRIC_ERROR_UNSUPPORTED,<br>BIOMETRIC_ERROR_HW_UNAVAILABLE,BIOMETRIC_ERROR_NONE_ENROLLED,BIOMETRIC_ERROR_NO_HARDWARE,<br>BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED,BIOMETRIC_AUTHENTICATION_CHECK_FAILED,<br>BIOMETRIC_ERROR_DEVICE_CREDENTIAL_NOT_AVAILABLE
-                biometricsFailed
                                                          NO_NETWORKNO_NETWORK
                                                          API_ERRORAPI_ERROR
                                                          
-          
-          
-          
                                                          
-            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.
-          
                                                          
-          
                                                          
-          
                                                          
-            <p align="center"> <picture> <source
-            media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> <source
-            media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150"> <img alt="Auth0 Logo"
-            src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> </picture> </p> <p
-            align="center">Auth0 is an easy to implement, adaptable
-            authentication and authorization platform. To learn more checkout
-            <a href="https://auth0.com/why-auth0">Why Auth0?</a></p> <p
-            align="center"> This project is licensed under the MIT
-            license. See the <a href="https://github.com/auth0/react-native-auth0/blob/master/LICENSE"> LICENSE</a> file for more info.</p>
-          
                                                          
-          
                                                          <!-- Variables -->
                                                          
-        
                                                          
-      
                                                          
-      
                                                          
-        
                                                          
-          
                                                          
-            
                                                          
-              
-                
-                
                                                          Settings
                                                          
-                                                                        
-              
                                                          
-                
                                                          
-                  Member Visibility
-                  
                                                            
-                    
                                                          • 
-                      
-                    
                                                            • 
-                    
                                                          • 
-                      
-                    
                                                            • 
-                  
                                                          
-                
                                                          
-                
                                                          
-                  
-                
                                                          
-              
                                                          
-            
                                                          
-          
                                                          
-          
                                                          
-            
-              
-              
                                                          On This Page
                                                          
-                                                                      
-            
                                                          
-              
-              DocumentationGetting Started
-              
-              Next Steps
-              
-              Feedback
-              
-            
                                                          
-          
                                                          
-        
                                                          
-        
                                                          
-          
-        
                                                          
-      
                                                          
-    
                                                          
-    
                                                          
-      
                                                          
-        Generated using
-        TypeDoc
-      
                                                          
-    
                                                          
-    
                                                          
-  
-
+
                                                          Detailed information on LocalAuthenticationOptions is available here
                                                          
+
                                                          LocalAuthenticationOptions:
                                                          
+
                                                          The options for configuring the display of local authentication prompt, authentication level (Android only), and evaluation policy (iOS only).
                                                          
+
                                                          Properties:
                                                          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                          PropertyTypeDescriptionApplicable Platforms
                                                          titleStringThe title of the authentication prompt.Android, iOS
                                                          subtitleString (optional)The subtitle of the authentication prompt.Android
                                                          descriptionString (optional)The description of the authentication prompt.Android
                                                          cancelTitleString (optional)The cancel button title of the authentication prompt.Android, iOS
                                                          evaluationPolicyLocalAuthenticationStrategy (optional)The evaluation policy to use when prompting the user for authentication. Defaults to deviceOwnerWithBiometrics.iOS
                                                          fallbackTitleString (optional)The fallback button title of the authentication prompt.iOS
                                                          authenticationLevelLocalAuthenticationLevel (optional)The authentication level to use when prompting the user for authentication. Defaults to strong.Android
                                                          deviceCredentialFallbackBoolean (optional)Should the user be given the option to authenticate with their device PIN, pattern, or password instead of a biometric. Defaults to falseAndroid
                                                          
+
                                                          > :warning: You need a real device to test Local Authentication for iOS. Local Authentication is not available in simulators.
                                                          
+
                                                          The Credentials Manager will only throw CredentialsManagerError exceptions. You can find more information in the details property of the exception.
                                                          
+
                                                          try {
                                                            const credentials = await auth0.credentialsManager.getCredentials();
                                                          } catch (error) {
                                                            console.log(error);
                                                          }
+
                                                          
+
+
                                                          Platform agnostic errors:
                                                          
+
                                                          You can access the platform agnostic generic error codes as below :
                                                          
+
                                                          try {
                                                            const credentials = await auth0.credentialsManager.getCredentials();
                                                          } catch (error) {
                                                            console.log(e.type);
                                                          }
+
                                                          
+
+
                                                          Note : We have platform agnostic error codes available only for CredentialsManagerError as of now.
                                                          
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
                                                          Generic Error CodeCorresponding Error Code in AndroidCorresponding Error Code in iOS
                                                          INVALID_CREDENTIALSINVALID_CREDENTIALS
                                                          NO_CREDENTIALSNO_CREDENTIALSnoCredentials
                                                          NO_REFRESH_TOKENNO_REFRESH_TOKENnoRefreshToken
                                                          RENEW_FAILEDRENEW_FAILEDrenewFailed
                                                          STORE_FAILEDSTORE_FAILEDstoreFailed
                                                          REVOKE_FAILEDREVOKE_FAILEDrevokeFailed
                                                          LARGE_MIN_TTLLARGE_MIN_TTLlargeMinTTL
                                                          INCOMPATIBLE_DEVICEINCOMPATIBLE_DEVICE
                                                          CRYPTO_EXCEPTIONCRYPTO_EXCEPTION
                                                          BIOMETRICS_FAILEDOneOf <br>BIOMETRIC_NO_ACTIVITY,BIOMETRIC_ERROR_STATUS_UNKNOWN,BIOMETRIC_ERROR_UNSUPPORTED,<br>BIOMETRIC_ERROR_HW_UNAVAILABLE,BIOMETRIC_ERROR_NONE_ENROLLED,BIOMETRIC_ERROR_NO_HARDWARE,<br>BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED,BIOMETRIC_AUTHENTICATION_CHECK_FAILED,<br>BIOMETRIC_ERROR_DEVICE_CREDENTIAL_NOT_AVAILABLEbiometricsFailed
                                                          NO_NETWORKNO_NETWORK
                                                          API_ERRORAPI_ERROR
                                                          
+
                                                          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.
                                                          
+
                                                          
+
                                                          <p align="center">
+<picture>
+<source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
+<source media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150">
+<img alt="Auth0 Logo" src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
+</picture>
+</p>
+<p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
+<p align="center">
+This project is licensed under the MIT license. See the <a href="https://github.com/auth0/react-native-auth0/blob/master/LICENSE"> LICENSE</a> file for more info.</p>
                                                          
+
                                                          <!-- Variables -->
                                                          
+

                                                          Settings

                                                          Member Visibility

                                                          On This Page

                                                          DocumentationGetting StartedNext StepsFeedback
                                                          diff --git a/docs/interfaces/Auth0Options.html b/docs/interfaces/Auth0Options.html new file mode 100644 index 00000000..a9d9e152 --- /dev/null +++ b/docs/interfaces/Auth0Options.html @@ -0,0 +1,14 @@ +Auth0Options | react-native-auth0
                                                          react-native-auth0
                                                            Preparing search index...

                                                            Interface Auth0Options

                                                            Options for configuring the Auth0 client.

                                                            +
                                                            interface Auth0Options {
                                                                clientId: string;
                                                                domain: string;
                                                                headers?: Record<string, string>;
                                                                localAuthenticationOptions?: LocalAuthenticationOptions;
                                                                telemetry?: Telemetry;
                                                                timeout?: number;
                                                            }
                                                            Index

                                                            Properties

                                                            clientId +domain +headers? +localAuthenticationOptions? +telemetry? +timeout? +

                                                            Properties

                                                            clientId: string

                                                            The client identifier of your application.

                                                            +
                                                            domain: string

                                                            The Auth0 domain for your tenant.

                                                            +
                                                            headers?: Record<string, string>

                                                            (Optional) Custom headers to include in requests.

                                                            +
                                                            localAuthenticationOptions?: LocalAuthenticationOptions

                                                            Options for configuring local authentication.

                                                            +
                                                            telemetry?: Telemetry

                                                            Telemetry information to include in requests.

                                                            +
                                                            timeout?: number

                                                            The timeout in milliseconds for network requests.

                                                            +

                                                            Settings

                                                            Member Visibility

                                                            On This Page

                                                            Properties
                                                            diff --git a/docs/interfaces/AuthorizeUrlOptions.html b/docs/interfaces/AuthorizeUrlOptions.html index e90c15d7..6b3c3833 100644 --- a/docs/interfaces/AuthorizeUrlOptions.html +++ b/docs/interfaces/AuthorizeUrlOptions.html @@ -1,501 +1,9 @@ - - - - - - AuthorizeUrlOptions | react-native-auth0 - - - - - - - - - - - - -
                                                            -
                                                            - react-native-auth0 - - - - -
                                                              -
                                                              -
                                                              Preparing search index...
                                                              -
                                                              -                                                               - -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              - -

                                                              Interface AuthorizeUrlOptions

                                                              -
                                                              -
                                                              -
                                                              -

                                                              Options for building a URL for /authorize

                                                              -
                                                              -
                                                              -
                                                              -
                                                              - interface - AuthorizeUrlOptions - {
                                                                  redirectUri: - object;
                                                                  responseType: - string;
                                                                  state: - object;
                                                                  [key: - string]: - any;
                                                              } -
                                                              -
                                                              -

                                                              Indexable

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

                                                                Custom parameters to send to /authorize

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

                                                              Properties

                                                              -
                                                              - - redirectUri - - responseType - - state -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              - - -

                                                              Properties

                                                              -                                                               -
                                                              -
                                                              - -
                                                              - redirectUri: - object -
                                                              -
                                                              -

                                                              - Where the authorization server will redirect back after - success or failure. -

                                                              -
                                                              -
                                                              - -
                                                              -
                                                              - -
                                                              - responseType: - string -
                                                              -
                                                              -

                                                              The response_type value

                                                              -
                                                              -
                                                              - -
                                                              -
                                                              - -
                                                              - state: - object -
                                                              -
                                                              -

                                                              Random string to prevent CSRF attacks.

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

                                                              Settings

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

                                                              On This Page

                                                              -                                                               -
                                                              -
                                                              - - Properties - - -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              - -
                                                              -
                                                              -
                                                              -
                                                              -

                                                              - Generated using - TypeDoc -

                                                              -
                                                              -
                                                              - - +AuthorizeUrlOptions | react-native-auth0
                                                              react-native-auth0
                                                                Preparing search index...

                                                                Interface AuthorizeUrlOptions

                                                                Options for building a URL for /authorize

                                                                +
                                                                interface AuthorizeUrlOptions {
                                                                    redirectUri: object;
                                                                    responseType: string;
                                                                    state: object;
                                                                    [key: string]: any;
                                                                }

                                                                Indexable

                                                                • [key: string]: any

                                                                  Custom parameters to send to /authorize

                                                                  +
                                                                Index

                                                                Properties

                                                                redirectUri +responseType +state +

                                                                Properties

                                                                redirectUri: object

                                                                Where the authorization server will redirect back after success or failure.

                                                                +
                                                                responseType: string

                                                                The response_type value

                                                                +
                                                                state: object

                                                                Random string to prevent CSRF attacks.

                                                                +

                                                                Settings

                                                                Member Visibility

                                                                On This Page

                                                                Properties
                                                                diff --git a/docs/interfaces/ClearSessionOptions.html b/docs/interfaces/ClearSessionOptions.html index 94108202..3e1ea655 100644 --- a/docs/interfaces/ClearSessionOptions.html +++ b/docs/interfaces/ClearSessionOptions.html @@ -1,435 +1,6 @@ - - - - - - ClearSessionOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                -
                                                                - react-native-auth0 - - - - -
                                                                  -
                                                                  -
                                                                  Preparing search index...
                                                                  -
                                                                  -                                                                   - -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  - -

                                                                  Interface ClearSessionOptions

                                                                  -
                                                                  -
                                                                  -
                                                                  -

                                                                  Options for configuring the SDK's clear session behaviour.

                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  - interface - ClearSessionOptions - {
                                                                      customScheme?: - string;
                                                                      useLegacyCallbackUrl?: - boolean;
                                                                  } -
                                                                  - -
                                                                  -
                                                                  -
                                                                  - - -
                                                                  Index
                                                                  -                                                                   -
                                                                  -
                                                                  -

                                                                  Properties

                                                                  -
                                                                  - - customScheme? - - useLegacyCallbackUrl? -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  - - -

                                                                  Properties

                                                                  -                                                                   -
                                                                  -
                                                                  - -
                                                                  - customScheme?: - string -
                                                                  -
                                                                  -

                                                                  - Android only: Custom scheme to build the - callback URL with. -

                                                                  -
                                                                  -
                                                                  - -
                                                                  -
                                                                  - -
                                                                  - useLegacyCallbackUrl?: - boolean -
                                                                  -
                                                                  -

                                                                  - This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details. -

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

                                                                  Settings

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

                                                                  On This Page

                                                                  -                                                                   -
                                                                  -
                                                                  - - Properties - - -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  - -
                                                                  -
                                                                  -
                                                                  -
                                                                  -

                                                                  - Generated using - TypeDoc -

                                                                  -
                                                                  -
                                                                  - - +ClearSessionOptions | react-native-auth0
                                                                  react-native-auth0
                                                                    Preparing search index...

                                                                    Interface ClearSessionOptions

                                                                    Options for configuring the SDK's clear session behaviour.

                                                                    +
                                                                    interface ClearSessionOptions {
                                                                        customScheme?: string;
                                                                        useLegacyCallbackUrl?: boolean;
                                                                    }
                                                                    Index

                                                                    Properties

                                                                    customScheme? +useLegacyCallbackUrl? +

                                                                    Properties

                                                                    customScheme?: string

                                                                    Android only: Custom scheme to build the callback URL with.

                                                                    +
                                                                    useLegacyCallbackUrl?: boolean

                                                                    This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details.

                                                                    +

                                                                    Settings

                                                                    Member Visibility

                                                                    On This Page

                                                                    Properties
                                                                    diff --git a/docs/interfaces/ClearSessionParameters.html b/docs/interfaces/ClearSessionParameters.html index f8678a54..ca92ef1f 100644 --- a/docs/interfaces/ClearSessionParameters.html +++ b/docs/interfaces/ClearSessionParameters.html @@ -1,473 +1,14 @@ - - - - - - ClearSessionParameters | react-native-auth0 - - - - - - - - - - - - -
                                                                    -
                                                                    - react-native-auth0 - - - - -
                                                                      -
                                                                      -
                                                                      Preparing search index...
                                                                      -
                                                                      -                                                                       - -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      - -

                                                                      Interface ClearSessionParameters

                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Parameters for sending to the Auth0 logout endpoint.

                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      - interface - ClearSessionParameters - {
                                                                          federated?: - boolean;
                                                                          returnToUrl?: - string;
                                                                      } -
                                                                      - -
                                                                      -
                                                                      -
                                                                      - - -
                                                                      Index
                                                                      -                                                                       -
                                                                      -
                                                                      -

                                                                      Properties

                                                                      -
                                                                      - - federated? - - returnToUrl? -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      - - -

                                                                      Properties

                                                                      -                                                                       -
                                                                      -
                                                                      - -
                                                                      - federated?: - boolean -
                                                                      -
                                                                      -

                                                                      - If true, the user will be signed out of any - connected identity providers in addition to their Auth0 - session. -

                                                                      -
                                                                      -
                                                                      -
                                                                      - -

                                                                      false

                                                                      -
                                                                      -
                                                                      - -

                                                                      - https://auth0.com/docs/authenticate/login/logout/log-users-out-of-idps -

                                                                      -
                                                                      -
                                                                      - -
                                                                      -
                                                                      - -
                                                                      - returnToUrl?: - string -
                                                                      -
                                                                      -

                                                                      - Specify a custom redirect URL to be used. Normally, you - wouldn't need to call this method manually as the default - value is autogenerated for you. -

                                                                      -

                                                                      - If you are using this, ensure a proper redirect URL is - constructed in the following format Android: - {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback - iOS: - {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -

                                                                      -

                                                                      - If you have useLegacyCallbackUrl set to true then - the redirect URL should in the format Android: - {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback - iOS: - {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -

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

                                                                      Settings

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

                                                                      On This Page

                                                                      -                                                                       -
                                                                      -
                                                                      - - Properties - - -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      - -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      - Generated using - TypeDoc -

                                                                      -
                                                                      -
                                                                      - - +ClearSessionParameters | react-native-auth0
                                                                      react-native-auth0
                                                                        Preparing search index...

                                                                        Interface ClearSessionParameters

                                                                        Parameters for sending to the Auth0 logout endpoint.

                                                                        +
                                                                        interface ClearSessionParameters {
                                                                            federated?: boolean;
                                                                            returnToUrl?: string;
                                                                        }
                                                                        Index

                                                                        Properties

                                                                        federated? +returnToUrl? +

                                                                        Properties

                                                                        federated?: boolean

                                                                        If true, the user will be signed out of any connected identity providers in addition to their Auth0 session.

                                                                        +

                                                                        false

                                                                        +

                                                                        https://auth0.com/docs/authenticate/login/logout/log-users-out-of-idps

                                                                        +
                                                                        returnToUrl?: string

                                                                        Specify a custom redirect URL to be used. Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.

                                                                        +

                                                                        If you are using this, ensure a proper redirect URL is constructed in the following format +Android: {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback +iOS: {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                        +

                                                                        If you have useLegacyCallbackUrl set to true then the redirect URL should in the format +Android: {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback +iOS: {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                        +

                                                                        Settings

                                                                        Member Visibility

                                                                        On This Page

                                                                        Properties
                                                                        diff --git a/docs/interfaces/CreateUserOptions.html b/docs/interfaces/CreateUserOptions.html index 4f847983..0d43b7b4 100644 --- a/docs/interfaces/CreateUserOptions.html +++ b/docs/interfaces/CreateUserOptions.html @@ -1,883 +1,24 @@ - - - - - - CreateUserOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                        -
                                                                        - react-native-auth0 - - - - -
                                                                          -
                                                                          -
                                                                          Preparing search index...
                                                                          -
                                                                          -                                                                           - -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          - -

                                                                          Interface CreateUserOptions

                                                                          -
                                                                          -
                                                                          -
                                                                          -

                                                                          Options for creating a new user.

                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          - interface - CreateUserOptions - {
                                                                              connection: - string;
                                                                              email: - string;
                                                                              family_name?: - string;
                                                                              given_name?: - string;
                                                                              metadata?: - object;
                                                                              name?: - string;
                                                                              nickname?: - string;
                                                                              password: - string;
                                                                              picture?: - string;
                                                                              username?: - string;
                                                                              [key: - string]: - any;
                                                                          } -
                                                                          -
                                                                          -

                                                                          Indexable

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

                                                                          Properties

                                                                          -
                                                                          - - connection - - email - - family_name? - - given_name? - - metadata? - - name? - - nickname? - - password - - picture? - - username? -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          - - -

                                                                          Properties

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

                                                                          - The name of the database connection where to create the user -

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

                                                                          The user's email

                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - -
                                                                          - family_name?: - string -
                                                                          -
                                                                          -

                                                                          The user's family name(s)

                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - -
                                                                          - given_name?: - string -
                                                                          -
                                                                          -

                                                                          The user's given name(s)

                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - -
                                                                          - metadata?: - object -
                                                                          -
                                                                          -

                                                                          - Additional information that will be stored in - user_metadata -

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

                                                                          The user's full name

                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - -
                                                                          - nickname?: - string -
                                                                          -
                                                                          -

                                                                          The user's nickname

                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - -
                                                                          - password: - string -
                                                                          -
                                                                          -

                                                                          The user's password

                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - -
                                                                          - picture?: - string -
                                                                          -
                                                                          -

                                                                          A URL pointing to the user's picture

                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - -
                                                                          - username?: - string -
                                                                          -
                                                                          -

                                                                          The user's username

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

                                                                          Settings

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

                                                                          On This Page

                                                                          -                                                                           -
                                                                          -
                                                                          - - Properties - - -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          -
                                                                          -
                                                                          -

                                                                          - Generated using - TypeDoc -

                                                                          -
                                                                          -
                                                                          - - +CreateUserOptions | react-native-auth0
                                                                          react-native-auth0
                                                                            Preparing search index...

                                                                            Interface CreateUserOptions

                                                                            Options for creating a new user.

                                                                            +
                                                                            interface CreateUserOptions {
                                                                                connection: string;
                                                                                email: string;
                                                                                family_name?: string;
                                                                                given_name?: string;
                                                                                headers?: Record<string, string>;
                                                                                metadata?: object;
                                                                                name?: string;
                                                                                nickname?: string;
                                                                                password: string;
                                                                                picture?: string;
                                                                                username?: string;
                                                                                [key: string]: any;
                                                                            }

                                                                            Indexable

                                                                            • [key: string]: any
                                                                            Index

                                                                            Properties

                                                                            connection +email +family_name? +given_name? +headers? +metadata? +name? +nickname? +password +picture? +username? +

                                                                            Properties

                                                                            connection: string

                                                                            The name of the database connection where to create the user

                                                                            +
                                                                            email: string

                                                                            The user's email

                                                                            +
                                                                            family_name?: string

                                                                            The user's family name(s)

                                                                            +
                                                                            given_name?: string

                                                                            The user's given name(s)

                                                                            +
                                                                            headers?: Record<string, string>

                                                                            (Optional) Custom headers to include in the request.

                                                                            +
                                                                            metadata?: object

                                                                            Additional information that will be stored in user_metadata

                                                                            +
                                                                            name?: string

                                                                            The user's full name

                                                                            +
                                                                            nickname?: string

                                                                            The user's nickname

                                                                            +
                                                                            password: string

                                                                            The user's password

                                                                            +
                                                                            picture?: string

                                                                            A URL pointing to the user's picture

                                                                            +
                                                                            username?: string

                                                                            The user's username

                                                                            +

                                                                            Settings

                                                                            Member Visibility

                                                                            On This Page

                                                                            Properties
                                                                            diff --git a/docs/interfaces/ExchangeNativeSocialOptions.html b/docs/interfaces/ExchangeNativeSocialOptions.html index 2b1b77a7..872534cc 100644 --- a/docs/interfaces/ExchangeNativeSocialOptions.html +++ b/docs/interfaces/ExchangeNativeSocialOptions.html @@ -1,622 +1,14 @@ - - - - - - ExchangeNativeSocialOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                            -
                                                                            - react-native-auth0 - - - - -
                                                                              -
                                                                              -
                                                                              Preparing search index...
                                                                              -
                                                                              -                                                                               - -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              - -

                                                                              Interface ExchangeNativeSocialOptions

                                                                              -
                                                                              -
                                                                              -
                                                                              -

                                                                              - Options for obtaining user tokens from an external provider's - token -

                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              - interface - ExchangeNativeSocialOptions - {
                                                                                  audience?: - string;
                                                                                  scope?: - string;
                                                                                  subjectToken: - string;
                                                                                  subjectTokenType: - string;
                                                                                  userProfile?: - string;
                                                                                  [key: - string]: - any;
                                                                              } -
                                                                              -
                                                                              -

                                                                              Indexable

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

                                                                              Properties

                                                                              -
                                                                              - - audience? - - scope? - - subjectToken - - subjectTokenType - - userProfile? -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              - - -

                                                                              Properties

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

                                                                              The API audience to request

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

                                                                              - The scopes requested for the issued tokens. e.g. - openid profile -

                                                                              -
                                                                              -
                                                                              - -
                                                                              -
                                                                              - -
                                                                              - subjectToken: - string -
                                                                              -
                                                                              -

                                                                              - The token returned by the native social authentication - solution -

                                                                              -
                                                                              -
                                                                              - -
                                                                              -
                                                                              - -
                                                                              - subjectTokenType: - string -
                                                                              -
                                                                              -

                                                                              - The identifier that indicates the native social authentication - solution -

                                                                              -
                                                                              -
                                                                              - -
                                                                              -
                                                                              - -
                                                                              - userProfile?: - string -
                                                                              -
                                                                              -

                                                                              - Additional profile attributes to set or override, only on - select native social authentication solutions -

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

                                                                              Settings

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

                                                                              On This Page

                                                                              -                                                                               -
                                                                              -
                                                                              - - Properties - - -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              - -
                                                                              -
                                                                              -
                                                                              -
                                                                              -

                                                                              - Generated using - TypeDoc -

                                                                              -
                                                                              -
                                                                              - - +ExchangeNativeSocialOptions | react-native-auth0
                                                                              react-native-auth0
                                                                                Preparing search index...

                                                                                Interface ExchangeNativeSocialOptions

                                                                                Options for obtaining user tokens from an external provider's token

                                                                                +
                                                                                interface ExchangeNativeSocialOptions {
                                                                                    audience?: string;
                                                                                    headers?: Record<string, string>;
                                                                                    scope?: string;
                                                                                    subjectToken: string;
                                                                                    subjectTokenType: string;
                                                                                    userProfile?: string;
                                                                                    [key: string]: any;
                                                                                }

                                                                                Indexable

                                                                                • [key: string]: any
                                                                                Index

                                                                                Properties

                                                                                audience? +headers? +scope? +subjectToken +subjectTokenType +userProfile? +

                                                                                Properties

                                                                                audience?: string

                                                                                The API audience to request

                                                                                +
                                                                                headers?: Record<string, string>

                                                                                (Optional) Custom headers to include in the request.

                                                                                +
                                                                                scope?: string

                                                                                The scopes requested for the issued tokens. e.g. openid profile

                                                                                +
                                                                                subjectToken: string

                                                                                The token returned by the native social authentication solution

                                                                                +
                                                                                subjectTokenType: string

                                                                                The identifier that indicates the native social authentication solution

                                                                                +
                                                                                userProfile?: string

                                                                                Additional profile attributes to set or override, only on select native social authentication solutions

                                                                                +

                                                                                Settings

                                                                                Member Visibility

                                                                                On This Page

                                                                                Properties
                                                                                diff --git a/docs/interfaces/ExchangeOptions.html b/docs/interfaces/ExchangeOptions.html index 7396aac8..ac5fb09c 100644 --- a/docs/interfaces/ExchangeOptions.html +++ b/docs/interfaces/ExchangeOptions.html @@ -1,507 +1,9 @@ - - - - - - ExchangeOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                -
                                                                                - react-native-auth0 - - - - -
                                                                                  -
                                                                                  -
                                                                                  Preparing search index...
                                                                                  -
                                                                                  -                                                                                   - -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - -

                                                                                  Interface ExchangeOptions

                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -

                                                                                  - Options for the /oauth/token endpoint to exchange a - code for an access token -

                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - interface - ExchangeOptions - {
                                                                                      code: - string;
                                                                                      redirectUri: - string;
                                                                                      verifier: - string;
                                                                                      [key: - string]: - any;
                                                                                  } -
                                                                                  -
                                                                                  -

                                                                                  Indexable

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

                                                                                    Custom parameters to send to the /oauth/token endpoint

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

                                                                                  Properties

                                                                                  -
                                                                                  - - code - - redirectUri - - verifier -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - - -

                                                                                  Properties

                                                                                  -                                                                                   -
                                                                                  -
                                                                                  - -
                                                                                  - code: - string -
                                                                                  -
                                                                                  -

                                                                                  The code returned by /authorize.

                                                                                  -
                                                                                  -
                                                                                  - -
                                                                                  -
                                                                                  - -
                                                                                  - redirectUri: - string -
                                                                                  -
                                                                                  -

                                                                                  - The original redirectUri used when calling - /authorize. -

                                                                                  -
                                                                                  -
                                                                                  - -
                                                                                  -
                                                                                  - -
                                                                                  - verifier: - string -
                                                                                  -
                                                                                  -

                                                                                  - The value used to generate the code challenge sent to - /authorize. -

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

                                                                                  Settings

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

                                                                                  On This Page

                                                                                  -                                                                                   -
                                                                                  -
                                                                                  - - Properties - - -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -

                                                                                  - Generated using - TypeDoc -

                                                                                  -
                                                                                  -
                                                                                  - - +ExchangeOptions | react-native-auth0
                                                                                  react-native-auth0
                                                                                    Preparing search index...

                                                                                    Interface ExchangeOptions

                                                                                    Options for the /oauth/token endpoint to exchange a code for an access token

                                                                                    +
                                                                                    interface ExchangeOptions {
                                                                                        code: string;
                                                                                        redirectUri: string;
                                                                                        verifier: string;
                                                                                        [key: string]: any;
                                                                                    }

                                                                                    Indexable

                                                                                    • [key: string]: any

                                                                                      Custom parameters to send to the /oauth/token endpoint

                                                                                      +
                                                                                    Index

                                                                                    Properties

                                                                                    code +redirectUri +verifier +

                                                                                    Properties

                                                                                    code: string

                                                                                    The code returned by /authorize.

                                                                                    +
                                                                                    redirectUri: string

                                                                                    The original redirectUri used when calling /authorize.

                                                                                    +
                                                                                    verifier: string

                                                                                    The value used to generate the code challenge sent to /authorize.

                                                                                    +

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    On This Page

                                                                                    Properties
                                                                                    diff --git a/docs/interfaces/GetUserOptions.html b/docs/interfaces/GetUserOptions.html index ddc7d1cf..dec594fb 100644 --- a/docs/interfaces/GetUserOptions.html +++ b/docs/interfaces/GetUserOptions.html @@ -1,374 +1,4 @@ - - - - - - GetUserOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                    -
                                                                                    - react-native-auth0 - - - - -
                                                                                      -
                                                                                      -
                                                                                      Preparing search index...
                                                                                      -
                                                                                      -                                                                                       - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -

                                                                                      Interface GetUserOptions

                                                                                      -
                                                                                      -
                                                                                      - interface - GetUserOptions - {
                                                                                          id: - string;
                                                                                          [key: - string]: - any;
                                                                                      } -
                                                                                      -
                                                                                      -

                                                                                      Indexable

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

                                                                                      Properties

                                                                                      -
                                                                                      - - id -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - - -

                                                                                      Properties

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

                                                                                      Settings

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

                                                                                      On This Page

                                                                                      -                                                                                       -
                                                                                      -
                                                                                      - - Properties - -
                                                                                      - - id -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -

                                                                                      - Generated using - TypeDoc -

                                                                                      -
                                                                                      -
                                                                                      - - +GetUserOptions | react-native-auth0
                                                                                      react-native-auth0
                                                                                        Preparing search index...

                                                                                        Interface GetUserOptions

                                                                                        interface GetUserOptions {
                                                                                            headers?: Record<string, string>;
                                                                                            id: string;
                                                                                            [key: string]: any;
                                                                                        }

                                                                                        Indexable

                                                                                        • [key: string]: any
                                                                                        Index

                                                                                        Properties

                                                                                        headers? +id +

                                                                                        Properties

                                                                                        headers?: Record<string, string>

                                                                                        (Optional) Custom headers to include in the request.

                                                                                        +
                                                                                        id: string

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        On This Page

                                                                                        Properties
                                                                                        diff --git a/docs/interfaces/LocalAuthenticationOptions.html b/docs/interfaces/LocalAuthenticationOptions.html index 0cdf43d0..48423fde 100644 --- a/docs/interfaces/LocalAuthenticationOptions.html +++ b/docs/interfaces/LocalAuthenticationOptions.html @@ -1,800 +1,18 @@ - - - - - - LocalAuthenticationOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                        -
                                                                                        - react-native-auth0 - - - - -
                                                                                          -
                                                                                          -
                                                                                          Preparing search index...
                                                                                          -
                                                                                          -                                                                                           - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - -

                                                                                          Interface LocalAuthenticationOptions

                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -

                                                                                          - The options for configuring the display of local authentication - prompt, authentication level (Android only) and evaluation policy - (iOS only). -

                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - interface - LocalAuthenticationOptions - {
                                                                                              authenticationLevel?: - LocalAuthenticationLevel;
                                                                                              cancelTitle?: - String;
                                                                                              description?: - String;
                                                                                              deviceCredentialFallback?: - Boolean;
                                                                                              evaluationPolicy?: - LocalAuthenticationStrategy;
                                                                                              fallbackTitle?: - String;
                                                                                              subtitle?: - String;
                                                                                              title: - String;
                                                                                          } -
                                                                                          - -
                                                                                          -
                                                                                          -
                                                                                          - - -
                                                                                          Index
                                                                                          -                                                                                           -
                                                                                          -
                                                                                          -

                                                                                          Properties

                                                                                          -
                                                                                          - - authenticationLevel? - - cancelTitle? - - description? - - deviceCredentialFallback? - - evaluationPolicy? - - fallbackTitle? - - subtitle? - - title -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - - -

                                                                                          Properties

                                                                                          -                                                                                           -
                                                                                          -
                                                                                          - -
                                                                                          - authenticationLevel?: - LocalAuthenticationLevel -
                                                                                          -
                                                                                          -

                                                                                          - The authentication level to use when prompting the user for - authentication. Defaults to LocalAuthenticationLevel.strong. - Applicable for Android only. -

                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - -
                                                                                          - cancelTitle?: - String -
                                                                                          -
                                                                                          -

                                                                                          - The cancel button title of the authentication prompt. - Applicable for both Android and iOS. -

                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - -
                                                                                          - description?: - String -
                                                                                          -
                                                                                          -

                                                                                          - The description of the authentication prompt. - Applicable for Android only. -

                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - -
                                                                                          - deviceCredentialFallback?: - Boolean -
                                                                                          -
                                                                                          -

                                                                                          - Should the user be given the option to authenticate with their - device PIN, pattern, or password instead of a biometric. - Applicable for Android only. -

                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - -
                                                                                          - evaluationPolicy?: - LocalAuthenticationStrategy -
                                                                                          -
                                                                                          -

                                                                                          - The evaluation policy to use when prompting the user for - authentication. Defaults to - LocalAuthenticationStrategy.deviceOwnerWithBiometrics. - Applicable for iOS only. -

                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - -
                                                                                          - fallbackTitle?: - String -
                                                                                          -
                                                                                          -

                                                                                          - The fallback button title of the authentication prompt. - Applicable for iOS only. -

                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - -
                                                                                          - subtitle?: - String -
                                                                                          -
                                                                                          -

                                                                                          - The subtitle of the authentication prompt. - Applicable for Android only. -

                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - -
                                                                                          - title: - String -
                                                                                          -
                                                                                          -

                                                                                          - The title of the authentication prompt. - Applicable for both Android and iOS. -

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

                                                                                          Settings

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

                                                                                          On This Page

                                                                                          -                                                                                           -
                                                                                          -
                                                                                          - - Properties - - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -

                                                                                          - Generated using - TypeDoc -

                                                                                          -
                                                                                          -
                                                                                          - - +LocalAuthenticationOptions | react-native-auth0
                                                                                          react-native-auth0
                                                                                            Preparing search index...

                                                                                            Interface LocalAuthenticationOptions

                                                                                            The options for configuring the display of local authentication prompt, authentication level (Android only) and evaluation policy (iOS only).

                                                                                            +
                                                                                            interface LocalAuthenticationOptions {
                                                                                                authenticationLevel?: LocalAuthenticationLevel;
                                                                                                cancelTitle?: String;
                                                                                                description?: String;
                                                                                                deviceCredentialFallback?: Boolean;
                                                                                                evaluationPolicy?: LocalAuthenticationStrategy;
                                                                                                fallbackTitle?: String;
                                                                                                subtitle?: String;
                                                                                                title: String;
                                                                                            }
                                                                                            Index

                                                                                            Properties

                                                                                            authenticationLevel? +cancelTitle? +description? +deviceCredentialFallback? +evaluationPolicy? +fallbackTitle? +subtitle? +title +

                                                                                            Properties

                                                                                            authenticationLevel?: LocalAuthenticationLevel

                                                                                            The authentication level to use when prompting the user for authentication. Defaults to LocalAuthenticationLevel.strong. Applicable for Android only.

                                                                                            +
                                                                                            cancelTitle?: String

                                                                                            The cancel button title of the authentication prompt. Applicable for both Android and iOS.

                                                                                            +
                                                                                            description?: String

                                                                                            The description of the authentication prompt. Applicable for Android only.

                                                                                            +
                                                                                            deviceCredentialFallback?: Boolean

                                                                                            Should the user be given the option to authenticate with their device PIN, pattern, or password instead of a biometric. Applicable for Android only.

                                                                                            +
                                                                                            evaluationPolicy?: LocalAuthenticationStrategy

                                                                                            The evaluation policy to use when prompting the user for authentication. Defaults to LocalAuthenticationStrategy.deviceOwnerWithBiometrics. Applicable for iOS only.

                                                                                            +
                                                                                            fallbackTitle?: String

                                                                                            The fallback button title of the authentication prompt. Applicable for iOS only.

                                                                                            +
                                                                                            subtitle?: String

                                                                                            The subtitle of the authentication prompt. Applicable for Android only.

                                                                                            +
                                                                                            title: String

                                                                                            The title of the authentication prompt. Applicable for both Android and iOS.

                                                                                            +

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            On This Page

                                                                                            Properties
                                                                                            diff --git a/docs/interfaces/LoginWithEmailOptions.html b/docs/interfaces/LoginWithEmailOptions.html index ba4b745e..a0cc995f 100644 --- a/docs/interfaces/LoginWithEmailOptions.html +++ b/docs/interfaces/LoginWithEmailOptions.html @@ -1,546 +1,12 @@ - - - - - - LoginWithEmailOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                            -
                                                                                            - react-native-auth0 - - - - -
                                                                                              -
                                                                                              -
                                                                                              Preparing search index...
                                                                                              -
                                                                                              -                                                                                               - -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - -

                                                                                              Interface LoginWithEmailOptions

                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -

                                                                                              - The options for completing the passwordless login with email - request -

                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - interface - LoginWithEmailOptions - {
                                                                                                  audience?: - string;
                                                                                                  code: - string;
                                                                                                  email: - string;
                                                                                                  scope?: - string;
                                                                                                  [key: - string]: - any;
                                                                                              } -
                                                                                              -
                                                                                              -

                                                                                              Indexable

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

                                                                                              Properties

                                                                                              -
                                                                                              - - audience? - - code - - email - - scope? -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - - -

                                                                                              Properties

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

                                                                                              The API audience to request

                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - -
                                                                                              - code: - string -
                                                                                              -
                                                                                              -

                                                                                              The code numeric value (OTP)

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

                                                                                              The email where the link/code was received

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

                                                                                              The scopes to request

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

                                                                                              Settings

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

                                                                                              On This Page

                                                                                              -                                                                                               -
                                                                                              -
                                                                                              - - Properties - - -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -

                                                                                              - Generated using - TypeDoc -

                                                                                              -
                                                                                              -
                                                                                              - - +LoginWithEmailOptions | react-native-auth0
                                                                                              react-native-auth0
                                                                                                Preparing search index...

                                                                                                Interface LoginWithEmailOptions

                                                                                                The options for completing the passwordless login with email request

                                                                                                +
                                                                                                interface LoginWithEmailOptions {
                                                                                                    audience?: string;
                                                                                                    code: string;
                                                                                                    email: string;
                                                                                                    headers?: Record<string, string>;
                                                                                                    scope?: string;
                                                                                                    [key: string]: any;
                                                                                                }

                                                                                                Indexable

                                                                                                • [key: string]: any
                                                                                                Index

                                                                                                Properties

                                                                                                audience? +code +email +headers? +scope? +

                                                                                                Properties

                                                                                                audience?: string

                                                                                                The API audience to request

                                                                                                +
                                                                                                code: string

                                                                                                The code numeric value (OTP)

                                                                                                +
                                                                                                email: string

                                                                                                The email where the link/code was received

                                                                                                +
                                                                                                headers?: Record<string, string>

                                                                                                (Optional) Custom headers to include in the request.

                                                                                                +
                                                                                                scope?: string

                                                                                                The scopes to request

                                                                                                +

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                On This Page

                                                                                                Properties
                                                                                                diff --git a/docs/interfaces/LoginWithOOBOptions.html b/docs/interfaces/LoginWithOOBOptions.html index e7168ae9..14554c31 100644 --- a/docs/interfaces/LoginWithOOBOptions.html +++ b/docs/interfaces/LoginWithOOBOptions.html @@ -1,503 +1,12 @@ - - - - - - LoginWithOOBOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                -
                                                                                                - react-native-auth0 - - - - -
                                                                                                  -
                                                                                                  -
                                                                                                  Preparing search index...
                                                                                                  -
                                                                                                  -                                                                                                   - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - -

                                                                                                  Interface LoginWithOOBOptions

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Options for logging in using an OOB code

                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - interface - LoginWithOOBOptions - {
                                                                                                      bindingCode?: - string;
                                                                                                      mfaToken: - string;
                                                                                                      oobCode: - string;
                                                                                                      [key: - string]: - any;
                                                                                                  } -
                                                                                                  -
                                                                                                  -

                                                                                                  Indexable

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

                                                                                                  Properties

                                                                                                  -
                                                                                                  - - bindingCode? - - mfaToken - - oobCode -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - - -

                                                                                                  Properties

                                                                                                  -                                                                                                   -
                                                                                                  -
                                                                                                  - -
                                                                                                  - bindingCode?: - string -
                                                                                                  -
                                                                                                  -

                                                                                                  - The code used to bind the side channel (used to deliver the - challenge) with the main channel you are using to - authenticate. This is usually an OTP-like code delivered as - part of the challenge message. -

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

                                                                                                  The token received in the previous login response

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

                                                                                                  The out of band code received in the challenge response.

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

                                                                                                  Settings

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

                                                                                                  On This Page

                                                                                                  -                                                                                                   -
                                                                                                  -
                                                                                                  - - Properties - - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  - Generated using - TypeDoc -

                                                                                                  -
                                                                                                  -
                                                                                                  - - +LoginWithOOBOptions | react-native-auth0
                                                                                                  react-native-auth0
                                                                                                    Preparing search index...

                                                                                                    Interface LoginWithOOBOptions

                                                                                                    Options for logging in using an OOB code

                                                                                                    +
                                                                                                    interface LoginWithOOBOptions {
                                                                                                        bindingCode?: string;
                                                                                                        headers?: Record<string, string>;
                                                                                                        mfaToken: string;
                                                                                                        oobCode: string;
                                                                                                        [key: string]: any;
                                                                                                    }

                                                                                                    Indexable

                                                                                                    • [key: string]: any
                                                                                                    Index

                                                                                                    Properties

                                                                                                    bindingCode? +headers? +mfaToken +oobCode +

                                                                                                    Properties

                                                                                                    bindingCode?: string

                                                                                                    The code used to bind the side channel (used to deliver the challenge) with the +main channel you are using to authenticate. This is usually an OTP-like code +delivered as part of the challenge message.

                                                                                                    +
                                                                                                    headers?: Record<string, string>

                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                    +
                                                                                                    mfaToken: string

                                                                                                    The token received in the previous login response

                                                                                                    +
                                                                                                    oobCode: string

                                                                                                    The out of band code received in the challenge response.

                                                                                                    +

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    On This Page

                                                                                                    Properties
                                                                                                    diff --git a/docs/interfaces/LoginWithOTPOptions.html b/docs/interfaces/LoginWithOTPOptions.html index 0cfa9245..e8bfe3f1 100644 --- a/docs/interfaces/LoginWithOTPOptions.html +++ b/docs/interfaces/LoginWithOTPOptions.html @@ -1,498 +1,11 @@ - - - - - - LoginWithOTPOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                    -
                                                                                                    - react-native-auth0 - - - - -
                                                                                                      -
                                                                                                      -
                                                                                                      Preparing search index...
                                                                                                      -
                                                                                                      -                                                                                                       - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -

                                                                                                      Interface LoginWithOTPOptions

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Options for logging in using an OTP code

                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - interface - LoginWithOTPOptions - {
                                                                                                          audience?: - string;
                                                                                                          mfaToken: - string;
                                                                                                          otp: - string;
                                                                                                          [key: - string]: - any;
                                                                                                      } -
                                                                                                      -
                                                                                                      -

                                                                                                      Indexable

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

                                                                                                      Properties

                                                                                                      -
                                                                                                      - - audience? - - mfaToken - - otp -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -

                                                                                                      Properties

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

                                                                                                      The API audience

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

                                                                                                      The token received in the previous login response

                                                                                                      -
                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      - -
                                                                                                      - otp: - string -
                                                                                                      -
                                                                                                      -

                                                                                                      - The one time password code provided by the resource owner, - typically obtained from an MFA application such as Google - Authenticator or Guardian. -

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

                                                                                                      Settings

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

                                                                                                      On This Page

                                                                                                      -                                                                                                       -
                                                                                                      -
                                                                                                      - - Properties - - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      - Generated using - TypeDoc -

                                                                                                      -
                                                                                                      -
                                                                                                      - - +LoginWithOTPOptions | react-native-auth0
                                                                                                      react-native-auth0
                                                                                                        Preparing search index...

                                                                                                        Interface LoginWithOTPOptions

                                                                                                        Options for logging in using an OTP code

                                                                                                        +
                                                                                                        interface LoginWithOTPOptions {
                                                                                                            audience?: string;
                                                                                                            headers?: Record<string, string>;
                                                                                                            mfaToken: string;
                                                                                                            otp: string;
                                                                                                            [key: string]: any;
                                                                                                        }

                                                                                                        Indexable

                                                                                                        • [key: string]: any
                                                                                                        Index

                                                                                                        Properties

                                                                                                        audience? +headers? +mfaToken +otp +

                                                                                                        Properties

                                                                                                        audience?: string

                                                                                                        The API audience

                                                                                                        +
                                                                                                        headers?: Record<string, string>

                                                                                                        (Optional) Custom headers to include in the request.

                                                                                                        +
                                                                                                        mfaToken: string

                                                                                                        The token received in the previous login response

                                                                                                        +
                                                                                                        otp: string

                                                                                                        The one time password code provided by the resource owner, typically obtained +from an MFA application such as Google Authenticator or Guardian.

                                                                                                        +

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        On This Page

                                                                                                        Properties
                                                                                                        diff --git a/docs/interfaces/LoginWithRecoveryCodeOptions.html b/docs/interfaces/LoginWithRecoveryCodeOptions.html index a5aef5b4..c0d214c7 100644 --- a/docs/interfaces/LoginWithRecoveryCodeOptions.html +++ b/docs/interfaces/LoginWithRecoveryCodeOptions.html @@ -1,444 +1,8 @@ - - - - - - LoginWithRecoveryCodeOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                        -
                                                                                                        - react-native-auth0 - - - - -
                                                                                                          -
                                                                                                          -
                                                                                                          Preparing search index...
                                                                                                          -
                                                                                                          -                                                                                                           - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -

                                                                                                          Interface LoginWithRecoveryCodeOptions

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Options for logging in using a recovery code

                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - interface - LoginWithRecoveryCodeOptions - {
                                                                                                              mfaToken: - string;
                                                                                                              recoveryCode: - string;
                                                                                                              [key: - string]: - any;
                                                                                                          } -
                                                                                                          -
                                                                                                          -

                                                                                                          Indexable

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

                                                                                                          Properties

                                                                                                          -
                                                                                                          - - mfaToken - - recoveryCode -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - - -

                                                                                                          Properties

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

                                                                                                          The token received in the previous login response

                                                                                                          -
                                                                                                          -
                                                                                                          - -
                                                                                                          -
                                                                                                          - -
                                                                                                          - recoveryCode: - string -
                                                                                                          -
                                                                                                          -

                                                                                                          The recovery code provided by the end-user.

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

                                                                                                          Settings

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

                                                                                                          On This Page

                                                                                                          -                                                                                                           -
                                                                                                          -
                                                                                                          - - Properties - - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          - Generated using - TypeDoc -

                                                                                                          -
                                                                                                          -
                                                                                                          - - +LoginWithRecoveryCodeOptions | react-native-auth0
                                                                                                          react-native-auth0
                                                                                                            Preparing search index...

                                                                                                            Interface LoginWithRecoveryCodeOptions

                                                                                                            Options for logging in using a recovery code

                                                                                                            +
                                                                                                            interface LoginWithRecoveryCodeOptions {
                                                                                                                headers?: Record<string, string>;
                                                                                                                mfaToken: string;
                                                                                                                recoveryCode: string;
                                                                                                                [key: string]: any;
                                                                                                            }

                                                                                                            Indexable

                                                                                                            • [key: string]: any
                                                                                                            Index

                                                                                                            Properties

                                                                                                            headers? +mfaToken +recoveryCode +

                                                                                                            Properties

                                                                                                            headers?: Record<string, string>

                                                                                                            (Optional) Custom headers to include in the request.

                                                                                                            +
                                                                                                            mfaToken: string

                                                                                                            The token received in the previous login response

                                                                                                            +
                                                                                                            recoveryCode: string

                                                                                                            The recovery code provided by the end-user.

                                                                                                            +

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            On This Page

                                                                                                            Properties
                                                                                                            diff --git a/docs/interfaces/LoginWithSMSOptions.html b/docs/interfaces/LoginWithSMSOptions.html index f8e39730..eee64367 100644 --- a/docs/interfaces/LoginWithSMSOptions.html +++ b/docs/interfaces/LoginWithSMSOptions.html @@ -1,548 +1,12 @@ - - - - - - LoginWithSMSOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                            -
                                                                                                            - react-native-auth0 - - - - -
                                                                                                              -
                                                                                                              -
                                                                                                              Preparing search index...
                                                                                                              -
                                                                                                              -                                                                                                               - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - -

                                                                                                              Interface LoginWithSMSOptions

                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              - The options for completing the passwordless login with SMS request -

                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - interface - LoginWithSMSOptions - {
                                                                                                                  audience?: - string;
                                                                                                                  code: - string;
                                                                                                                  phoneNumber: - string;
                                                                                                                  scope?: - string;
                                                                                                                  [key: - string]: - any;
                                                                                                              } -
                                                                                                              -
                                                                                                              -

                                                                                                              Indexable

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

                                                                                                              Properties

                                                                                                              -
                                                                                                              - - audience? - - code - - phoneNumber - - scope? -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - - -

                                                                                                              Properties

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

                                                                                                              Optional API audience to request

                                                                                                              -
                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - code: - string -
                                                                                                              -
                                                                                                              -

                                                                                                              The code numeric value (OTP)

                                                                                                              -
                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              - -
                                                                                                              - phoneNumber: - string -
                                                                                                              -
                                                                                                              -

                                                                                                              The phone number where the code was received

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

                                                                                                              Optional scopes to request

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

                                                                                                              Settings

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

                                                                                                              On This Page

                                                                                                              -                                                                                                               -
                                                                                                              -
                                                                                                              - - Properties - - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              - Generated using - TypeDoc -

                                                                                                              -
                                                                                                              -
                                                                                                              - - +LoginWithSMSOptions | react-native-auth0
                                                                                                              react-native-auth0
                                                                                                                Preparing search index...

                                                                                                                Interface LoginWithSMSOptions

                                                                                                                The options for completing the passwordless login with SMS request

                                                                                                                +
                                                                                                                interface LoginWithSMSOptions {
                                                                                                                    audience?: string;
                                                                                                                    code: string;
                                                                                                                    headers?: Record<string, string>;
                                                                                                                    phoneNumber: string;
                                                                                                                    scope?: string;
                                                                                                                    [key: string]: any;
                                                                                                                }

                                                                                                                Indexable

                                                                                                                • [key: string]: any
                                                                                                                Index

                                                                                                                Properties

                                                                                                                audience? +code +headers? +phoneNumber +scope? +

                                                                                                                Properties

                                                                                                                audience?: string

                                                                                                                Optional API audience to request

                                                                                                                +
                                                                                                                code: string

                                                                                                                The code numeric value (OTP)

                                                                                                                +
                                                                                                                headers?: Record<string, string>

                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                +
                                                                                                                phoneNumber: string

                                                                                                                The phone number where the code was received

                                                                                                                +
                                                                                                                scope?: string

                                                                                                                Optional scopes to request

                                                                                                                +

                                                                                                                Settings

                                                                                                                Member Visibility

                                                                                                                On This Page

                                                                                                                Properties
                                                                                                                diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 4ad45421..f566f2d9 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,507 +1,9 @@ - - - - - - LogoutUrlOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                -
                                                                                                                - react-native-auth0 - - - - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  Preparing search index...
                                                                                                                  -
                                                                                                                  -                                                                                                                   - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -

                                                                                                                  Interface LogoutUrlOptions

                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Options for the logout endpoint

                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - interface - LogoutUrlOptions - {
                                                                                                                      clientId?: - string;
                                                                                                                      federated?: - boolean;
                                                                                                                      returnTo?: - string;
                                                                                                                      [key: - string]: - any;
                                                                                                                  } -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Indexable

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

                                                                                                                    Custom parameters to send to the logout endpoint

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

                                                                                                                  Properties

                                                                                                                  -
                                                                                                                  - - clientId? - - federated? - - returnTo? -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - -

                                                                                                                  Properties

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

                                                                                                                  The client identifier of the one requesting the logout

                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - federated?: - boolean -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  - Whether the logout should include removing session for - federated IdP. -

                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - returnTo?: - string -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  - URL where the user is redirected to after logout. It must be - declared in you Auth0 Dashboard -

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

                                                                                                                  Settings

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

                                                                                                                  On This Page

                                                                                                                  -                                                                                                                   -
                                                                                                                  -
                                                                                                                  - - Properties - - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  - Generated using - TypeDoc -

                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - +LogoutUrlOptions | react-native-auth0
                                                                                                                  react-native-auth0
                                                                                                                    Preparing search index...

                                                                                                                    Interface LogoutUrlOptions

                                                                                                                    Options for the logout endpoint

                                                                                                                    +
                                                                                                                    interface LogoutUrlOptions {
                                                                                                                        clientId?: string;
                                                                                                                        federated?: boolean;
                                                                                                                        returnTo?: string;
                                                                                                                        [key: string]: any;
                                                                                                                    }

                                                                                                                    Indexable

                                                                                                                    • [key: string]: any

                                                                                                                      Custom parameters to send to the logout endpoint

                                                                                                                      +
                                                                                                                    Index

                                                                                                                    Properties

                                                                                                                    clientId? +federated? +returnTo? +

                                                                                                                    Properties

                                                                                                                    clientId?: string

                                                                                                                    The client identifier of the one requesting the logout

                                                                                                                    +
                                                                                                                    federated?: boolean

                                                                                                                    Whether the logout should include removing session for federated IdP.

                                                                                                                    +
                                                                                                                    returnTo?: string

                                                                                                                    URL where the user is redirected to after logout. It must be declared in you Auth0 Dashboard

                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    On This Page

                                                                                                                    Properties
                                                                                                                    diff --git a/docs/interfaces/MultifactorChallengeOptions.html b/docs/interfaces/MultifactorChallengeOptions.html index 57306d85..7dd84d46 100644 --- a/docs/interfaces/MultifactorChallengeOptions.html +++ b/docs/interfaces/MultifactorChallengeOptions.html @@ -1,506 +1,12 @@ - - - - - - MultifactorChallengeOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                    -
                                                                                                                    - react-native-auth0 - - - - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      Preparing search index...
                                                                                                                      -
                                                                                                                      -                                                                                                                       - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -

                                                                                                                      Interface MultifactorChallengeOptions

                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Options for multifactor challenge.

                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - interface - MultifactorChallengeOptions - {
                                                                                                                          authenticatorId?: - string;
                                                                                                                          challengeType?: - string;
                                                                                                                          mfaToken: - string;
                                                                                                                          [key: - string]: - any;
                                                                                                                      } -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Indexable

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

                                                                                                                      Properties

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

                                                                                                                      Properties

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

                                                                                                                      The ID of the authenticator to challenge.

                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - challengeType?: - string -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      - A whitespace-separated list of the challenges types accepted - by your application. Accepted challenge types are oob or otp. - Excluding this parameter means that your client application - accepts all supported challenge types. -

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

                                                                                                                      The token received in the previous login response

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

                                                                                                                      Settings

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

                                                                                                                      On This Page

                                                                                                                      -                                                                                                                       -
                                                                                                                      -
                                                                                                                      - - Properties - - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      - Generated using - TypeDoc -

                                                                                                                      -
                                                                                                                      -
                                                                                                                      - - +MultifactorChallengeOptions | react-native-auth0
                                                                                                                      react-native-auth0
                                                                                                                        Preparing search index...

                                                                                                                        Interface MultifactorChallengeOptions

                                                                                                                        Options for multifactor challenge.

                                                                                                                        +
                                                                                                                        interface MultifactorChallengeOptions {
                                                                                                                            authenticatorId?: string;
                                                                                                                            challengeType?: string;
                                                                                                                            headers?: Record<string, string>;
                                                                                                                            mfaToken: string;
                                                                                                                            [key: string]: any;
                                                                                                                        }

                                                                                                                        Indexable

                                                                                                                        • [key: string]: any
                                                                                                                        Index

                                                                                                                        Properties

                                                                                                                        authenticatorId? +challengeType? +headers? +mfaToken +

                                                                                                                        Properties

                                                                                                                        authenticatorId?: string

                                                                                                                        The ID of the authenticator to challenge.

                                                                                                                        +
                                                                                                                        challengeType?: string

                                                                                                                        A whitespace-separated list of the challenges types accepted by your application. +Accepted challenge types are oob or otp. Excluding this parameter means that your client application +accepts all supported challenge types.

                                                                                                                        +
                                                                                                                        headers?: Record<string, string>

                                                                                                                        (Optional) Custom headers to include in the request.

                                                                                                                        +
                                                                                                                        mfaToken: string

                                                                                                                        The token received in the previous login response

                                                                                                                        +

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        On This Page

                                                                                                                        Properties
                                                                                                                        diff --git a/docs/interfaces/PasswordRealmOptions.html b/docs/interfaces/PasswordRealmOptions.html index 307f470f..0297523f 100644 --- a/docs/interfaces/PasswordRealmOptions.html +++ b/docs/interfaces/PasswordRealmOptions.html @@ -1,610 +1,14 @@ - - - - - - PasswordRealmOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                        -
                                                                                                                        - react-native-auth0 - - - - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          Preparing search index...
                                                                                                                          -
                                                                                                                          -                                                                                                                           - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Interface PasswordRealmOptions

                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - Options for authenticating using the username & password - grant. -

                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - interface - PasswordRealmOptions - {
                                                                                                                              audience?: - string;
                                                                                                                              password: - string;
                                                                                                                              realm: - string;
                                                                                                                              scope?: - string;
                                                                                                                              username: - string;
                                                                                                                              [key: - string]: - any;
                                                                                                                          } -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          Indexable

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

                                                                                                                          Properties

                                                                                                                          -
                                                                                                                          - - audience? - - password - - realm - - scope? - - username -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -

                                                                                                                          Properties

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

                                                                                                                          - The identifier of Resource Server (RS) to be included as - audience (aud claim) of the issued access token -

                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - password: - string -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          The user's password

                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - realm: - string -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          The name of the Realm where to Auth (or connection name)

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

                                                                                                                          - The scopes requested for the issued tokens. e.g. - openid profile -

                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - username: - string -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          The user's username or email

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

                                                                                                                          Settings

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

                                                                                                                          On This Page

                                                                                                                          -                                                                                                                           -
                                                                                                                          -
                                                                                                                          - - Properties - - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - Generated using - TypeDoc -

                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - +PasswordRealmOptions | react-native-auth0
                                                                                                                          react-native-auth0
                                                                                                                            Preparing search index...

                                                                                                                            Interface PasswordRealmOptions

                                                                                                                            Options for authenticating using the username & password grant.

                                                                                                                            +
                                                                                                                            interface PasswordRealmOptions {
                                                                                                                                audience?: string;
                                                                                                                                headers?: Record<string, string>;
                                                                                                                                password: string;
                                                                                                                                realm: string;
                                                                                                                                scope?: string;
                                                                                                                                username: string;
                                                                                                                                [key: string]: any;
                                                                                                                            }

                                                                                                                            Indexable

                                                                                                                            • [key: string]: any
                                                                                                                            Index

                                                                                                                            Properties

                                                                                                                            audience? +headers? +password +realm +scope? +username +

                                                                                                                            Properties

                                                                                                                            audience?: string

                                                                                                                            The identifier of Resource Server (RS) to be included as audience (aud claim) of the issued access token

                                                                                                                            +
                                                                                                                            headers?: Record<string, string>

                                                                                                                            (Optional) Custom headers to include in the request.

                                                                                                                            +
                                                                                                                            password: string

                                                                                                                            The user's password

                                                                                                                            +
                                                                                                                            realm: string

                                                                                                                            The name of the Realm where to Auth (or connection name)

                                                                                                                            +
                                                                                                                            scope?: string

                                                                                                                            The scopes requested for the issued tokens. e.g. openid profile

                                                                                                                            +
                                                                                                                            username: string

                                                                                                                            The user's username or email

                                                                                                                            +

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            Properties
                                                                                                                            diff --git a/docs/interfaces/PasswordlessWithEmailOptions.html b/docs/interfaces/PasswordlessWithEmailOptions.html index 53714cbf..0bdbeae2 100644 --- a/docs/interfaces/PasswordlessWithEmailOptions.html +++ b/docs/interfaces/PasswordlessWithEmailOptions.html @@ -1,494 +1,10 @@ - - - - - - PasswordlessWithEmailOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                            -
                                                                                                                            - react-native-auth0 - - - - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              Preparing search index...
                                                                                                                              -
                                                                                                                              -                                                                                                                               - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -

                                                                                                                              Interface PasswordlessWithEmailOptions

                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Options for requesting passwordless login using email

                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - interface - PasswordlessWithEmailOptions - {
                                                                                                                                  authParams?: - object;
                                                                                                                                  email: - string;
                                                                                                                                  send?: - string;
                                                                                                                                  [key: - string]: - any;
                                                                                                                              } -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Indexable

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

                                                                                                                              Properties

                                                                                                                              -
                                                                                                                              - - authParams? - - email - - send? -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - -

                                                                                                                              Properties

                                                                                                                              -                                                                                                                               -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - authParams?: - object -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Optional parameters, used when strategy is 'linḱ'

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

                                                                                                                              The email to send the link/code to

                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - send?: - string -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              The passwordless strategy, either 'link' or 'code'

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

                                                                                                                              Settings

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

                                                                                                                              On This Page

                                                                                                                              -                                                                                                                               -
                                                                                                                              -
                                                                                                                              - - Properties - - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              - Generated using - TypeDoc -

                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - +PasswordlessWithEmailOptions | react-native-auth0
                                                                                                                              react-native-auth0
                                                                                                                                Preparing search index...

                                                                                                                                Interface PasswordlessWithEmailOptions

                                                                                                                                Options for requesting passwordless login using email

                                                                                                                                +
                                                                                                                                interface PasswordlessWithEmailOptions {
                                                                                                                                    authParams?: object;
                                                                                                                                    email: string;
                                                                                                                                    headers?: Record<string, string>;
                                                                                                                                    send?: string;
                                                                                                                                    [key: string]: any;
                                                                                                                                }

                                                                                                                                Indexable

                                                                                                                                • [key: string]: any
                                                                                                                                Index

                                                                                                                                Properties

                                                                                                                                authParams? +email +headers? +send? +

                                                                                                                                Properties

                                                                                                                                authParams?: object

                                                                                                                                Optional parameters, used when strategy is 'linḱ'

                                                                                                                                +
                                                                                                                                email: string

                                                                                                                                The email to send the link/code to

                                                                                                                                +
                                                                                                                                headers?: Record<string, string>

                                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                                +
                                                                                                                                send?: string

                                                                                                                                The passwordless strategy, either 'link' or 'code'

                                                                                                                                +

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                On This Page

                                                                                                                                Properties
                                                                                                                                diff --git a/docs/interfaces/PasswordlessWithSMSOptions.html b/docs/interfaces/PasswordlessWithSMSOptions.html index 31f78e5a..d371e4a2 100644 --- a/docs/interfaces/PasswordlessWithSMSOptions.html +++ b/docs/interfaces/PasswordlessWithSMSOptions.html @@ -1,497 +1,10 @@ - - - - - - PasswordlessWithSMSOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                -
                                                                                                                                - react-native-auth0 - - - - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  Preparing search index...
                                                                                                                                  -
                                                                                                                                  -                                                                                                                                   - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -

                                                                                                                                  Interface PasswordlessWithSMSOptions

                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Options for requesting passwordless login using SMS

                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - interface - PasswordlessWithSMSOptions - {
                                                                                                                                      authParams?: - object;
                                                                                                                                      phoneNumber: - string;
                                                                                                                                      send?: - string;
                                                                                                                                      [key: - string]: - any;
                                                                                                                                  } -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Indexable

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

                                                                                                                                  Properties

                                                                                                                                  -
                                                                                                                                  - - authParams? - - phoneNumber - - send? -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - -

                                                                                                                                  Properties

                                                                                                                                  -                                                                                                                                   -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  - authParams?: - object -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Optional passwordless parameters

                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  - phoneNumber: - string -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  The phone number to send the link/code to

                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  - send?: - string -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  The passwordless strategy, either 'link' or 'code'

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

                                                                                                                                  Settings

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

                                                                                                                                  On This Page

                                                                                                                                  -                                                                                                                                   -
                                                                                                                                  -
                                                                                                                                  - - Properties - - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  - Generated using - TypeDoc -

                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - +PasswordlessWithSMSOptions | react-native-auth0
                                                                                                                                  react-native-auth0
                                                                                                                                    Preparing search index...

                                                                                                                                    Interface PasswordlessWithSMSOptions

                                                                                                                                    Options for requesting passwordless login using SMS

                                                                                                                                    +
                                                                                                                                    interface PasswordlessWithSMSOptions {
                                                                                                                                        authParams?: object;
                                                                                                                                        headers?: Record<string, string>;
                                                                                                                                        phoneNumber: string;
                                                                                                                                        send?: string;
                                                                                                                                        [key: string]: any;
                                                                                                                                    }

                                                                                                                                    Indexable

                                                                                                                                    • [key: string]: any
                                                                                                                                    Index

                                                                                                                                    Properties

                                                                                                                                    authParams? +headers? +phoneNumber +send? +

                                                                                                                                    Properties

                                                                                                                                    authParams?: object

                                                                                                                                    Optional passwordless parameters

                                                                                                                                    +
                                                                                                                                    headers?: Record<string, string>

                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                    +
                                                                                                                                    phoneNumber: string

                                                                                                                                    The phone number to send the link/code to

                                                                                                                                    +
                                                                                                                                    send?: string

                                                                                                                                    The passwordless strategy, either 'link' or 'code'

                                                                                                                                    +

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    On This Page

                                                                                                                                    Properties
                                                                                                                                    diff --git a/docs/interfaces/PatchUserOptions.html b/docs/interfaces/PatchUserOptions.html index c0562be1..7dd272a8 100644 --- a/docs/interfaces/PatchUserOptions.html +++ b/docs/interfaces/PatchUserOptions.html @@ -1,425 +1,5 @@ - - - - - - PatchUserOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                    -
                                                                                                                                    - react-native-auth0 - - - - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      Preparing search index...
                                                                                                                                      -
                                                                                                                                      -                                                                                                                                       - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - -

                                                                                                                                      Interface PatchUserOptions

                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - interface - PatchUserOptions - {
                                                                                                                                          id: - string;
                                                                                                                                          metadata: - object;
                                                                                                                                          [key: - string]: - any;
                                                                                                                                      } -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      Indexable

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

                                                                                                                                      Properties

                                                                                                                                      -
                                                                                                                                      - - id - - metadata -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - - -

                                                                                                                                      Properties

                                                                                                                                      -                                                                                                                                       -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      - id: - string -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      - metadata: - object -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - - -

                                                                                                                                      Settings

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

                                                                                                                                      On This Page

                                                                                                                                      -                                                                                                                                       -
                                                                                                                                      -
                                                                                                                                      - - Properties - - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - Generated using - TypeDoc -

                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - - +PatchUserOptions | react-native-auth0
                                                                                                                                      react-native-auth0
                                                                                                                                        Preparing search index...

                                                                                                                                        Interface PatchUserOptions

                                                                                                                                        interface PatchUserOptions {
                                                                                                                                            headers?: Record<string, string>;
                                                                                                                                            id: string;
                                                                                                                                            metadata: object;
                                                                                                                                            [key: string]: any;
                                                                                                                                        }

                                                                                                                                        Indexable

                                                                                                                                        • [key: string]: any
                                                                                                                                        Index

                                                                                                                                        Properties

                                                                                                                                        headers? +id +metadata +

                                                                                                                                        Properties

                                                                                                                                        headers?: Record<string, string>

                                                                                                                                        (Optional) Custom headers to include in the request.

                                                                                                                                        +
                                                                                                                                        id: string
                                                                                                                                        metadata: object

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        On This Page

                                                                                                                                        Properties
                                                                                                                                        diff --git a/docs/interfaces/RefreshTokenOptions.html b/docs/interfaces/RefreshTokenOptions.html index cfa54a6a..695848a8 100644 --- a/docs/interfaces/RefreshTokenOptions.html +++ b/docs/interfaces/RefreshTokenOptions.html @@ -1,442 +1,8 @@ - - - - - - RefreshTokenOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                        -
                                                                                                                                        - react-native-auth0 - - - - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          Preparing search index...
                                                                                                                                          -
                                                                                                                                          -                                                                                                                                           - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -

                                                                                                                                          Interface RefreshTokenOptions

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Refresh token parameters

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - interface - RefreshTokenOptions - {
                                                                                                                                              refreshToken: - string;
                                                                                                                                              scope?: - string;
                                                                                                                                              [key: - string]: - any;
                                                                                                                                          } -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Indexable

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

                                                                                                                                          Properties

                                                                                                                                          -
                                                                                                                                          - - refreshToken - - scope? -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - -

                                                                                                                                          Properties

                                                                                                                                          -                                                                                                                                           -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - refreshToken: - string -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          The issued refresh token

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

                                                                                                                                          - The scopes requested for the issued tokens. e.g. - openid profile -

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

                                                                                                                                          Settings

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

                                                                                                                                          On This Page

                                                                                                                                          -                                                                                                                                           -
                                                                                                                                          -
                                                                                                                                          - - Properties - - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - Generated using - TypeDoc -

                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - +RefreshTokenOptions | react-native-auth0
                                                                                                                                          react-native-auth0
                                                                                                                                            Preparing search index...

                                                                                                                                            Interface RefreshTokenOptions

                                                                                                                                            Refresh token parameters

                                                                                                                                            +
                                                                                                                                            interface RefreshTokenOptions {
                                                                                                                                                headers?: Record<string, string>;
                                                                                                                                                refreshToken: string;
                                                                                                                                                scope?: string;
                                                                                                                                                [key: string]: any;
                                                                                                                                            }

                                                                                                                                            Indexable

                                                                                                                                            • [key: string]: any
                                                                                                                                            Index

                                                                                                                                            Properties

                                                                                                                                            headers? +refreshToken +scope? +

                                                                                                                                            Properties

                                                                                                                                            headers?: Record<string, string>

                                                                                                                                            (Optional) Custom headers to include in the request.

                                                                                                                                            +
                                                                                                                                            refreshToken: string

                                                                                                                                            The issued refresh token

                                                                                                                                            +
                                                                                                                                            scope?: string

                                                                                                                                            The scopes requested for the issued tokens. e.g. openid profile

                                                                                                                                            +

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            On This Page

                                                                                                                                            Properties
                                                                                                                                            diff --git a/docs/interfaces/ResetPasswordOptions.html b/docs/interfaces/ResetPasswordOptions.html index 42163bbd..c9c16e77 100644 --- a/docs/interfaces/ResetPasswordOptions.html +++ b/docs/interfaces/ResetPasswordOptions.html @@ -1,439 +1,8 @@ - - - - - - ResetPasswordOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                            -
                                                                                                                                            - react-native-auth0 - - - - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              Preparing search index...
                                                                                                                                              -
                                                                                                                                              -                                                                                                                                               - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              Interface ResetPasswordOptions

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Options for resetting a user's password.

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - interface - ResetPasswordOptions - {
                                                                                                                                                  connection: - string;
                                                                                                                                                  email: - string;
                                                                                                                                                  [key: - string]: - any;
                                                                                                                                              } -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Indexable

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

                                                                                                                                              Properties

                                                                                                                                              -
                                                                                                                                              - - connection - - email -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - -

                                                                                                                                              Properties

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

                                                                                                                                              The name of the database connection of the user

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

                                                                                                                                              The user's email

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

                                                                                                                                              Settings

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

                                                                                                                                              On This Page

                                                                                                                                              -                                                                                                                                               -
                                                                                                                                              -
                                                                                                                                              - - Properties - - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - Generated using - TypeDoc -

                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - +ResetPasswordOptions | react-native-auth0
                                                                                                                                              react-native-auth0
                                                                                                                                                Preparing search index...

                                                                                                                                                Interface ResetPasswordOptions

                                                                                                                                                Options for resetting a user's password.

                                                                                                                                                +
                                                                                                                                                interface ResetPasswordOptions {
                                                                                                                                                    connection: string;
                                                                                                                                                    email: string;
                                                                                                                                                    headers?: Record<string, string>;
                                                                                                                                                    [key: string]: any;
                                                                                                                                                }

                                                                                                                                                Indexable

                                                                                                                                                • [key: string]: any
                                                                                                                                                Index

                                                                                                                                                Properties

                                                                                                                                                connection +email +headers? +

                                                                                                                                                Properties

                                                                                                                                                connection: string

                                                                                                                                                The name of the database connection of the user

                                                                                                                                                +
                                                                                                                                                email: string

                                                                                                                                                The user's email

                                                                                                                                                +
                                                                                                                                                headers?: Record<string, string>

                                                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                                                +

                                                                                                                                                Settings

                                                                                                                                                Member Visibility

                                                                                                                                                On This Page

                                                                                                                                                Properties
                                                                                                                                                diff --git a/docs/interfaces/RevokeOptions.html b/docs/interfaces/RevokeOptions.html index 50266f72..11acfadc 100644 --- a/docs/interfaces/RevokeOptions.html +++ b/docs/interfaces/RevokeOptions.html @@ -1,387 +1,6 @@ - - - - - - RevokeOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                - react-native-auth0 - - - - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  Preparing search index...
                                                                                                                                                  -
                                                                                                                                                  -                                                                                                                                                   - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -

                                                                                                                                                  Interface RevokeOptions

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Options for the revoke refresh token endpoint.

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - interface - RevokeOptions - {
                                                                                                                                                      refreshToken: - string;
                                                                                                                                                      [key: - string]: - any;
                                                                                                                                                  } -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  Indexable

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

                                                                                                                                                  Properties

                                                                                                                                                  -
                                                                                                                                                  - - refreshToken -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - - -

                                                                                                                                                  Properties

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  - refreshToken: - string -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  The user's issued refresh token

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

                                                                                                                                                  Settings

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

                                                                                                                                                  On This Page

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -
                                                                                                                                                  - - Properties - - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -

                                                                                                                                                  - Generated using - TypeDoc -

                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - - +RevokeOptions | react-native-auth0
                                                                                                                                                  react-native-auth0
                                                                                                                                                    Preparing search index...

                                                                                                                                                    Interface RevokeOptions

                                                                                                                                                    Options for the revoke refresh token endpoint.

                                                                                                                                                    +
                                                                                                                                                    interface RevokeOptions {
                                                                                                                                                        headers?: Record<string, string>;
                                                                                                                                                        refreshToken: string;
                                                                                                                                                        [key: string]: any;
                                                                                                                                                    }

                                                                                                                                                    Indexable

                                                                                                                                                    • [key: string]: any
                                                                                                                                                    Index

                                                                                                                                                    Properties

                                                                                                                                                    headers? +refreshToken +

                                                                                                                                                    Properties

                                                                                                                                                    headers?: Record<string, string>

                                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                                    +
                                                                                                                                                    refreshToken: string

                                                                                                                                                    The user's issued refresh token

                                                                                                                                                    +

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    On This Page

                                                                                                                                                    Properties
                                                                                                                                                    diff --git a/docs/interfaces/Types.Auth0ContextInterface.html b/docs/interfaces/Types.Auth0ContextInterface.html index 63f80a42..e0628132 100644 --- a/docs/interfaces/Types.Auth0ContextInterface.html +++ b/docs/interfaces/Types.Auth0ContextInterface.html @@ -1,2676 +1,55 @@ - - - - - - Auth0ContextInterface | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                    -
                                                                                                                                                    - react-native-auth0 - - - - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      Preparing search index...
                                                                                                                                                      -
                                                                                                                                                      -                                                                                                                                                       - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -

                                                                                                                                                      Interface Auth0ContextInterface<TUser>

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - interface - Auth0ContextInterface<TUser - extends - User - = - User> - {
                                                                                                                                                          authorize: - (
                                                                                                                                                              parameters?: - WebAuthorizeParameters,
                                                                                                                                                              options?: - WebAuthorizeOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          authorizeWithEmail: - (
                                                                                                                                                              parameters: - LoginWithEmailOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          authorizeWithExchangeNativeSocial: - (
                                                                                                                                                              parameters: - ExchangeNativeSocialOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          authorizeWithOOB: - (
                                                                                                                                                              parameters: - LoginWithOOBOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          authorizeWithOTP: - (
                                                                                                                                                              parameters: - LoginWithOTPOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          authorizeWithPasswordRealm: - (
                                                                                                                                                              parameters: - PasswordRealmOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          authorizeWithRecoveryCode: - (
                                                                                                                                                              parameters: - LoginWithRecoveryCodeOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          authorizeWithSMS: - (
                                                                                                                                                              parameters: - LoginWithSMSOptions,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          cancelWebAuth: - () - => - Promise<void>;
                                                                                                                                                          clearCredentials: - () - => - Promise<void>;
                                                                                                                                                          clearSession: - (
                                                                                                                                                              parameters?: - ClearSessionParameters,
                                                                                                                                                              options?: - ClearSessionOptions,
                                                                                                                                                          ) - => - Promise<void>;
                                                                                                                                                          error: - null - | - BaseError;
                                                                                                                                                          getCredentials: - (
                                                                                                                                                              scope?: - string,
                                                                                                                                                              minTtl?: - number,
                                                                                                                                                              parameters?: - Record<string, - unknown>,
                                                                                                                                                              forceRefresh?: - boolean,
                                                                                                                                                          ) - => - Promise<undefined - | - Credentials>;
                                                                                                                                                          hasValidCredentials: - (minTtl?: - number) - => - Promise<boolean>;
                                                                                                                                                          isLoading: - boolean;
                                                                                                                                                          resetPassword: - (parameters: - ResetPasswordOptions) - => - Promise<void>;
                                                                                                                                                          revokeRefreshToken: - (parameters: - RevokeOptions) - => - Promise<void>;
                                                                                                                                                          sendEmailCode: - (parameters: - PasswordlessWithEmailOptions) - => - Promise<void>;
                                                                                                                                                          sendMultifactorChallenge: - (
                                                                                                                                                              parameters: - MultifactorChallengeOptions,
                                                                                                                                                          ) - => - Promise<void>;
                                                                                                                                                          sendSMSCode: - (parameters: - PasswordlessWithSMSOptions) - => - Promise<void>;
                                                                                                                                                          user: - null - | - TUser;
                                                                                                                                                      } -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Type Parameters

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • - TUser - extends - User - = - User -
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Hierarchy (View Summary) -

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

                                                                                                                                                      Properties

                                                                                                                                                      -
                                                                                                                                                      - - authorize - - authorizeWithEmail - - authorizeWithExchangeNativeSocial - - authorizeWithOOB - - authorizeWithOTP - - authorizeWithPasswordRealm - - authorizeWithRecoveryCode - - authorizeWithSMS - - cancelWebAuth - - clearCredentials - - clearSession - - error - - getCredentials - - hasValidCredentials - - isLoading - - resetPassword - - revokeRefreshToken - - sendEmailCode - - sendMultifactorChallenge - - sendSMSCode - - user -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - - -

                                                                                                                                                      Properties

                                                                                                                                                      -                                                                                                                                                       -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorize: - (
                                                                                                                                                          parameters?: - WebAuthorizeParameters,
                                                                                                                                                          options?: - WebAuthorizeOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Authorize the user using Auth0 Universal Login. See <a - href="../classes/Types.WebAuth.html#authorize" - class="tsd-kind-method">WebAuth#authorize</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Type declaration

                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorizeWithEmail: - (
                                                                                                                                                          parameters: - LoginWithEmailOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Authorize the user using an email code. See <a - href="../classes/Types.Auth.html#loginwithemail" - class="tsd-kind-method">Auth#loginWithEmail</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorizeWithExchangeNativeSocial: - (
                                                                                                                                                          parameters: - ExchangeNativeSocialOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Authorize user with credentials using the Password Realm - Grant. See <a - href="../classes/Types.Auth.html#passwordrealm" - class="tsd-kind-method">Auth#passwordRealm</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorizeWithOOB: - (
                                                                                                                                                          parameters: - LoginWithOOBOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Authorize the user using an Out Of Band authentication code. - See <a - href="../classes/Types.Auth.html#loginwithoob" - class="tsd-kind-method">Auth#loginWithOOB</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorizeWithOTP: - (
                                                                                                                                                          parameters: - LoginWithOTPOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Autohrize the user using a One Time Password code. See <a - href="../classes/Types.Auth.html#loginwithotp" - class="tsd-kind-method">Auth#loginWithOTP</a>. -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorizeWithPasswordRealm: - (
                                                                                                                                                          parameters: - PasswordRealmOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Authorize user with credentials using the Password Realm - Grant. See <a - href="../classes/Types.Auth.html#passwordrealm" - class="tsd-kind-method">Auth#passwordRealm</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorizeWithRecoveryCode: - (
                                                                                                                                                          parameters: - LoginWithRecoveryCodeOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Authorize the user using a multi-factor authentication - Recovery Code. See <a - href="../classes/Types.Auth.html#loginwithrecoverycode" - class="tsd-kind-method">Auth#loginWithRecoveryCode</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - authorizeWithSMS: - (
                                                                                                                                                          parameters: - LoginWithSMSOptions,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Authorize the user using a SMS code. See <a - href="../classes/Types.Auth.html#loginwithsms" - class="tsd-kind-method">Auth#loginWithSMS</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - cancelWebAuth: - () - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Cancel any ongoing Universal Login transaction. This works - only on iOS and not on any other platforms -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - clearCredentials: - () - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Clears the user's credentials without clearing their web - session and logs them out. -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - clearSession: - (
                                                                                                                                                          parameters?: - ClearSessionParameters,
                                                                                                                                                          options?: - ClearSessionOptions,
                                                                                                                                                      ) - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Clears the user's web session, credentials and logs them out. - See <a - href="../classes/Types.WebAuth.html#clearsession" - class="tsd-kind-method">WebAuth#clearSession</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Type declaration

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • -
                                                                                                                                                          -
                                                                                                                                                        • - (
                                                                                                                                                              parameters?: - ClearSessionParameters,
                                                                                                                                                              options?: - ClearSessionOptions,
                                                                                                                                                          ): - Promise<void> -
                                                                                                                                                          • -
                                                                                                                                                        • -
                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - Optionalparameters: - ClearSessionParameters -
                                                                                                                                                            -

                                                                                                                                                            - Additional parameters to send to the Auth0 - logout endpoint. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          • - Optionaloptions: - ClearSessionOptions -
                                                                                                                                                            -

                                                                                                                                                            - Options for configuring the SDK's clear - session behaviour. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Returns Promise<void> -

                                                                                                                                                          -
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - error: - null - | - BaseError -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      An object representing the last exception

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - getCredentials: - (
                                                                                                                                                          scope?: - string,
                                                                                                                                                          minTtl?: - number,
                                                                                                                                                          parameters?: - Record<string, - unknown>,
                                                                                                                                                          forceRefresh?: - boolean,
                                                                                                                                                      ) - => - Promise<undefined - | - Credentials> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Gets the user's credentials from the native credential store. - If credentials have expired, they are automatically refreshed - by default. See <a - href="../classes/Types.CredentialsManager.html#getcredentials" - class="tsd-kind-method">CredentialsManager#getCredentials</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Type declaration

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • -
                                                                                                                                                          -
                                                                                                                                                        • - (
                                                                                                                                                              scope?: - string,
                                                                                                                                                              minTtl?: - number,
                                                                                                                                                              parameters?: - Record<string, - unknown>,
                                                                                                                                                              forceRefresh?: - boolean,
                                                                                                                                                          ): - Promise<undefined - | - Credentials> -
                                                                                                                                                          • -
                                                                                                                                                        • -
                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - Optionalscope: - string -
                                                                                                                                                            -

                                                                                                                                                            The scopes used to get the credentials

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          • - OptionalminTtl: - number -
                                                                                                                                                            -

                                                                                                                                                            - The minimum time in seconds that the access - token should last before expiration -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          • - Optionalparameters: Record<string, - unknown> -
                                                                                                                                                            -

                                                                                                                                                            - Any additional parameters to send in the - request to refresh expired credentials. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          • - OptionalforceRefresh: - boolean -
                                                                                                                                                            -

                                                                                                                                                            - If true, credentials are always - refreshed regardless of their expiry, provided - a valid refresh token is available. -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Returns Promise<undefined - | - Credentials> -

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - hasValidCredentials: - (minTtl?: - number) - => - Promise<boolean> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Whether the SDK currently holds valid, unexpired credentials. -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      Type declaration

                                                                                                                                                      -
                                                                                                                                                        -
                                                                                                                                                      • -
                                                                                                                                                          -
                                                                                                                                                        • - (minTtl?: - number): - Promise<boolean> -
                                                                                                                                                          • -
                                                                                                                                                        • -
                                                                                                                                                          -

                                                                                                                                                          Parameters

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - OptionalminTtl: - number -
                                                                                                                                                            -

                                                                                                                                                            - The minimum time in seconds that the access - token should last before expiration -

                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Returns Promise<boolean> -

                                                                                                                                                          -

                                                                                                                                                          - true if there are valid credentials. - Otherwise, false. -

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          • -
                                                                                                                                                        -
                                                                                                                                                        • -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - isLoading: - boolean -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - A flag that is true until the state knows that a user is - either logged in or not -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - resetPassword: - (parameters: - ResetPasswordOptions) - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Request an email with instructions to change password of a - user <a - href="../classes/Types.Auth.html#resetpassword" - class="tsd-kind-method">Auth#resetPassword</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - revokeRefreshToken: - (parameters: - RevokeOptions) - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Revokes an issued refresh token. See <a - href="../classes/Types.Auth.html#revoke" - class="tsd-kind-method">Auth#revoke</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - sendEmailCode: - (parameters: - PasswordlessWithEmailOptions) - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Start the passwordless email login flow. See <a - href="../classes/Types.Auth.html#passwordlesswithemail" - class="tsd-kind-method">Auth#passwordlessWithEmail</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - sendMultifactorChallenge: - (
                                                                                                                                                          parameters: - MultifactorChallengeOptions,
                                                                                                                                                      ) - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Send a challenge for multi-factor authentication. See <a - href="../classes/Types.Auth.html#multifactorchallenge" - class="tsd-kind-method">Auth#multifactorChallenge</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - sendSMSCode: - (parameters: - PasswordlessWithSMSOptions) - => - Promise<void> -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Start the passwordless SMS login flow. See <a - href="../classes/Types.Auth.html#passwordlesswithsms" - class="tsd-kind-method">Auth#passwordlessWithSMS</a> -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      - user: - null - | - TUser -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - The user profile as decoded from the ID token after - authentication -

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

                                                                                                                                                      Settings

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

                                                                                                                                                      On This Page

                                                                                                                                                      -                                                                                                                                                       -
                                                                                                                                                      -
                                                                                                                                                      - - Properties - - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      -

                                                                                                                                                      - Generated using - TypeDoc -

                                                                                                                                                      -
                                                                                                                                                      -
                                                                                                                                                      - - +Auth0ContextInterface | react-native-auth0
                                                                                                                                                      react-native-auth0
                                                                                                                                                        Preparing search index...

                                                                                                                                                        Interface Auth0ContextInterface<TUser>

                                                                                                                                                        interface Auth0ContextInterface<TUser extends User = User> {
                                                                                                                                                            authorize: (
                                                                                                                                                                parameters?: WebAuthorizeParameters,
                                                                                                                                                                options?: WebAuthorizeOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            authorizeWithEmail: (
                                                                                                                                                                parameters: LoginWithEmailOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            authorizeWithExchangeNativeSocial: (
                                                                                                                                                                parameters: ExchangeNativeSocialOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            authorizeWithOOB: (
                                                                                                                                                                parameters: LoginWithOOBOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            authorizeWithOTP: (
                                                                                                                                                                parameters: LoginWithOTPOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            authorizeWithPasswordRealm: (
                                                                                                                                                                parameters: PasswordRealmOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            authorizeWithRecoveryCode: (
                                                                                                                                                                parameters: LoginWithRecoveryCodeOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            authorizeWithSMS: (
                                                                                                                                                                parameters: LoginWithSMSOptions,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            cancelWebAuth: () => Promise<void>;
                                                                                                                                                            clearCredentials: () => Promise<void>;
                                                                                                                                                            clearSession: (
                                                                                                                                                                parameters?: ClearSessionParameters,
                                                                                                                                                                options?: ClearSessionOptions,
                                                                                                                                                            ) => Promise<void>;
                                                                                                                                                            error: null | BaseError;
                                                                                                                                                            getCredentials: (
                                                                                                                                                                scope?: string,
                                                                                                                                                                minTtl?: number,
                                                                                                                                                                parameters?: Record<string, unknown>,
                                                                                                                                                                forceRefresh?: boolean,
                                                                                                                                                            ) => Promise<undefined | Credentials>;
                                                                                                                                                            hasValidCredentials: (minTtl?: number) => Promise<boolean>;
                                                                                                                                                            isLoading: boolean;
                                                                                                                                                            resetPassword: (parameters: ResetPasswordOptions) => Promise<void>;
                                                                                                                                                            revokeRefreshToken: (parameters: RevokeOptions) => Promise<void>;
                                                                                                                                                            sendEmailCode: (parameters: PasswordlessWithEmailOptions) => Promise<void>;
                                                                                                                                                            sendMultifactorChallenge: (
                                                                                                                                                                parameters: MultifactorChallengeOptions,
                                                                                                                                                            ) => Promise<void>;
                                                                                                                                                            sendSMSCode: (parameters: PasswordlessWithSMSOptions) => Promise<void>;
                                                                                                                                                            user: null | TUser;
                                                                                                                                                        }

                                                                                                                                                        Type Parameters

                                                                                                                                                        Hierarchy (View Summary)

                                                                                                                                                        Index

                                                                                                                                                        Properties

                                                                                                                                                        authorize +authorizeWithEmail +authorizeWithExchangeNativeSocial +authorizeWithOOB +authorizeWithOTP +authorizeWithPasswordRealm +authorizeWithRecoveryCode +authorizeWithSMS +cancelWebAuth +clearCredentials +clearSession +error +getCredentials +hasValidCredentials +isLoading +resetPassword +revokeRefreshToken +sendEmailCode +sendMultifactorChallenge +sendSMSCode +user +

                                                                                                                                                        Properties

                                                                                                                                                        authorize: (
                                                                                                                                                            parameters?: WebAuthorizeParameters,
                                                                                                                                                            options?: WebAuthorizeOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Authorize the user using Auth0 Universal Login. See <a href="../classes/Types.WebAuth.html#authorize" class="tsd-kind-method">WebAuth#authorize</a>

                                                                                                                                                        +

                                                                                                                                                        Type declaration

                                                                                                                                                        authorizeWithEmail: (
                                                                                                                                                            parameters: LoginWithEmailOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Authorize the user using an email code. See <a href="../classes/Types.Auth.html#loginwithemail" class="tsd-kind-method">Auth#loginWithEmail</a>

                                                                                                                                                        +
                                                                                                                                                        authorizeWithExchangeNativeSocial: (
                                                                                                                                                            parameters: ExchangeNativeSocialOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Authorize user with credentials using the Password Realm Grant. See <a href="../classes/Types.Auth.html#passwordrealm" class="tsd-kind-method">Auth#passwordRealm</a>

                                                                                                                                                        +
                                                                                                                                                        authorizeWithOOB: (
                                                                                                                                                            parameters: LoginWithOOBOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Authorize the user using an Out Of Band authentication code. See <a href="../classes/Types.Auth.html#loginwithoob" class="tsd-kind-method">Auth#loginWithOOB</a>

                                                                                                                                                        +
                                                                                                                                                        authorizeWithOTP: (
                                                                                                                                                            parameters: LoginWithOTPOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Autohrize the user using a One Time Password code. See <a href="../classes/Types.Auth.html#loginwithotp" class="tsd-kind-method">Auth#loginWithOTP</a>.

                                                                                                                                                        +
                                                                                                                                                        authorizeWithPasswordRealm: (
                                                                                                                                                            parameters: PasswordRealmOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Authorize user with credentials using the Password Realm Grant. See <a href="../classes/Types.Auth.html#passwordrealm" class="tsd-kind-method">Auth#passwordRealm</a>

                                                                                                                                                        +
                                                                                                                                                        authorizeWithRecoveryCode: (
                                                                                                                                                            parameters: LoginWithRecoveryCodeOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Authorize the user using a multi-factor authentication Recovery Code. See <a href="../classes/Types.Auth.html#loginwithrecoverycode" class="tsd-kind-method">Auth#loginWithRecoveryCode</a>

                                                                                                                                                        +
                                                                                                                                                        authorizeWithSMS: (
                                                                                                                                                            parameters: LoginWithSMSOptions,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Authorize the user using a SMS code. See <a href="../classes/Types.Auth.html#loginwithsms" class="tsd-kind-method">Auth#loginWithSMS</a>

                                                                                                                                                        +
                                                                                                                                                        cancelWebAuth: () => Promise<void>

                                                                                                                                                        Cancel any ongoing Universal Login transaction. +This works only on iOS and not on any other platforms

                                                                                                                                                        +
                                                                                                                                                        clearCredentials: () => Promise<void>

                                                                                                                                                        Clears the user's credentials without clearing their web session and logs them out.

                                                                                                                                                        +
                                                                                                                                                        clearSession: (
                                                                                                                                                            parameters?: ClearSessionParameters,
                                                                                                                                                            options?: ClearSessionOptions,
                                                                                                                                                        ) => Promise<void>

                                                                                                                                                        Clears the user's web session, credentials and logs them out. See <a href="../classes/Types.WebAuth.html#clearsession" class="tsd-kind-method">WebAuth#clearSession</a>

                                                                                                                                                        +

                                                                                                                                                        Type declaration

                                                                                                                                                        error: null | BaseError

                                                                                                                                                        An object representing the last exception

                                                                                                                                                        +
                                                                                                                                                        getCredentials: (
                                                                                                                                                            scope?: string,
                                                                                                                                                            minTtl?: number,
                                                                                                                                                            parameters?: Record<string, unknown>,
                                                                                                                                                            forceRefresh?: boolean,
                                                                                                                                                        ) => Promise<undefined | Credentials>

                                                                                                                                                        Gets the user's credentials from the native credential store. If credentials have expired, they are automatically refreshed +by default. See <a href="../classes/Types.CredentialsManager.html#getcredentials" class="tsd-kind-method">CredentialsManager#getCredentials</a>

                                                                                                                                                        +

                                                                                                                                                        Type declaration

                                                                                                                                                          • (
                                                                                                                                                                scope?: string,
                                                                                                                                                                minTtl?: number,
                                                                                                                                                                parameters?: Record<string, unknown>,
                                                                                                                                                                forceRefresh?: boolean,
                                                                                                                                                            ): Promise<undefined | Credentials>

                                                                                                                                                          • Parameters

                                                                                                                                                            • Optionalscope: string

                                                                                                                                                              The scopes used to get the credentials

                                                                                                                                                              +
                                                                                                                                                            • OptionalminTtl: number

                                                                                                                                                              The minimum time in seconds that the access token should last before expiration

                                                                                                                                                              +
                                                                                                                                                            • Optionalparameters: Record<string, unknown>

                                                                                                                                                              Any additional parameters to send in the request to refresh expired credentials.

                                                                                                                                                              +
                                                                                                                                                            • OptionalforceRefresh: boolean

                                                                                                                                                              If true, credentials are always refreshed regardless of their expiry, provided a valid refresh token is available.

                                                                                                                                                              +

                                                                                                                                                            Returns Promise<undefined | Credentials>

                                                                                                                                                        hasValidCredentials: (minTtl?: number) => Promise<boolean>

                                                                                                                                                        Whether the SDK currently holds valid, unexpired credentials.

                                                                                                                                                        +

                                                                                                                                                        Type declaration

                                                                                                                                                          • (minTtl?: number): Promise<boolean>

                                                                                                                                                          • Parameters

                                                                                                                                                            • OptionalminTtl: number

                                                                                                                                                              The minimum time in seconds that the access token should last before expiration

                                                                                                                                                              +

                                                                                                                                                            Returns Promise<boolean>

                                                                                                                                                            true if there are valid credentials. Otherwise, false.

                                                                                                                                                            +
                                                                                                                                                        isLoading: boolean

                                                                                                                                                        A flag that is true until the state knows that a user is either logged in or not

                                                                                                                                                        +
                                                                                                                                                        resetPassword: (parameters: ResetPasswordOptions) => Promise<void>

                                                                                                                                                        Request an email with instructions to change password of a user <a href="../classes/Types.Auth.html#resetpassword" class="tsd-kind-method">Auth#resetPassword</a>

                                                                                                                                                        +
                                                                                                                                                        revokeRefreshToken: (parameters: RevokeOptions) => Promise<void>

                                                                                                                                                        Revokes an issued refresh token. See <a href="../classes/Types.Auth.html#revoke" class="tsd-kind-method">Auth#revoke</a>

                                                                                                                                                        +
                                                                                                                                                        sendEmailCode: (parameters: PasswordlessWithEmailOptions) => Promise<void>

                                                                                                                                                        Start the passwordless email login flow. See <a href="../classes/Types.Auth.html#passwordlesswithemail" class="tsd-kind-method">Auth#passwordlessWithEmail</a>

                                                                                                                                                        +
                                                                                                                                                        sendMultifactorChallenge: (
                                                                                                                                                            parameters: MultifactorChallengeOptions,
                                                                                                                                                        ) => Promise<void>

                                                                                                                                                        Send a challenge for multi-factor authentication. See <a href="../classes/Types.Auth.html#multifactorchallenge" class="tsd-kind-method">Auth#multifactorChallenge</a>

                                                                                                                                                        +
                                                                                                                                                        sendSMSCode: (parameters: PasswordlessWithSMSOptions) => Promise<void>

                                                                                                                                                        Start the passwordless SMS login flow. See <a href="../classes/Types.Auth.html#passwordlesswithsms" class="tsd-kind-method">Auth#passwordlessWithSMS</a>

                                                                                                                                                        +
                                                                                                                                                        user: null | TUser

                                                                                                                                                        The user profile as decoded from the ID token after authentication

                                                                                                                                                        +

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility

                                                                                                                                                        On This Page

                                                                                                                                                        Properties
                                                                                                                                                        diff --git a/docs/interfaces/Types.AuthState.html b/docs/interfaces/Types.AuthState.html index 8d2840eb..ad779616 100644 --- a/docs/interfaces/Types.AuthState.html +++ b/docs/interfaces/Types.AuthState.html @@ -1,549 +1,7 @@ - - - - - - AuthState | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                        -
                                                                                                                                                        - react-native-auth0 - - - - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          Preparing search index...
                                                                                                                                                          -
                                                                                                                                                          -                                                                                                                                                           - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -

                                                                                                                                                          Interface AuthState<TUser>

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - interface - AuthState<TUser - extends - User - = - User> - {
                                                                                                                                                              error: - null - | - BaseError;
                                                                                                                                                              isLoading: - boolean;
                                                                                                                                                              user: - null - | - TUser;
                                                                                                                                                          } -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          Type Parameters

                                                                                                                                                          -
                                                                                                                                                            -
                                                                                                                                                          • - TUser - extends - User - = - User -
                                                                                                                                                            • -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Hierarchy (View Summary) -

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

                                                                                                                                                          Properties

                                                                                                                                                          -
                                                                                                                                                          - - error - - isLoading - - user -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - - -

                                                                                                                                                          Properties

                                                                                                                                                          -                                                                                                                                                           -
                                                                                                                                                          -
                                                                                                                                                          - -
                                                                                                                                                          - error: - null - | - BaseError -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          An object representing the last exception

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          - -
                                                                                                                                                          - isLoading: - boolean -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - A flag that is true until the state knows that a user is - either logged in or not -

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          - -
                                                                                                                                                          - user: - null - | - TUser -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - The user profile as decoded from the ID token after - authentication -

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

                                                                                                                                                          Settings

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

                                                                                                                                                          On This Page

                                                                                                                                                          -                                                                                                                                                           -
                                                                                                                                                          -
                                                                                                                                                          - - Properties - - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          -

                                                                                                                                                          - Generated using - TypeDoc -

                                                                                                                                                          -
                                                                                                                                                          -
                                                                                                                                                          - - +AuthState | react-native-auth0
                                                                                                                                                          react-native-auth0
                                                                                                                                                            Preparing search index...

                                                                                                                                                            Interface AuthState<TUser>

                                                                                                                                                            interface AuthState<TUser extends User = User> {
                                                                                                                                                                error: null | BaseError;
                                                                                                                                                                isLoading: boolean;
                                                                                                                                                                user: null | TUser;
                                                                                                                                                            }

                                                                                                                                                            Type Parameters

                                                                                                                                                            Hierarchy (View Summary)

                                                                                                                                                            Index

                                                                                                                                                            Properties

                                                                                                                                                            error +isLoading +user +

                                                                                                                                                            Properties

                                                                                                                                                            error: null | BaseError

                                                                                                                                                            An object representing the last exception

                                                                                                                                                            +
                                                                                                                                                            isLoading: boolean

                                                                                                                                                            A flag that is true until the state knows that a user is either logged in or not

                                                                                                                                                            +
                                                                                                                                                            user: null | TUser

                                                                                                                                                            The user profile as decoded from the ID token after authentication

                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            On This Page

                                                                                                                                                            Properties
                                                                                                                                                            diff --git a/docs/interfaces/UserInfoOptions.html b/docs/interfaces/UserInfoOptions.html index d814086b..c862f2a3 100644 --- a/docs/interfaces/UserInfoOptions.html +++ b/docs/interfaces/UserInfoOptions.html @@ -1,362 +1,6 @@ - - - - - - UserInfoOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                            -
                                                                                                                                                            - react-native-auth0 - - - - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              Preparing search index...
                                                                                                                                                              -
                                                                                                                                                              -                                                                                                                                                               - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -

                                                                                                                                                              Interface UserInfoOptions

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Options for accessing the /userinfo endpoint.

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - interface - UserInfoOptions - {
                                                                                                                                                                  token: - string;
                                                                                                                                                              } -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -
                                                                                                                                                              Index
                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              Properties

                                                                                                                                                              -
                                                                                                                                                              - - token -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - -

                                                                                                                                                              Properties

                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              - token: - string -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              The user's access token

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

                                                                                                                                                              Settings

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

                                                                                                                                                              On This Page

                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -
                                                                                                                                                              - - Properties - - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              -

                                                                                                                                                              - Generated using - TypeDoc -

                                                                                                                                                              -
                                                                                                                                                              -
                                                                                                                                                              - - +UserInfoOptions | react-native-auth0
                                                                                                                                                              react-native-auth0
                                                                                                                                                                Preparing search index...

                                                                                                                                                                Interface UserInfoOptions

                                                                                                                                                                Options for accessing the /userinfo endpoint.

                                                                                                                                                                +
                                                                                                                                                                interface UserInfoOptions {
                                                                                                                                                                    headers?: Record<string, string>;
                                                                                                                                                                    token: string;
                                                                                                                                                                }
                                                                                                                                                                Index

                                                                                                                                                                Properties

                                                                                                                                                                headers? +token +

                                                                                                                                                                Properties

                                                                                                                                                                headers?: Record<string, string>

                                                                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                                                                +
                                                                                                                                                                token: string

                                                                                                                                                                The user's access token

                                                                                                                                                                +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                On This Page

                                                                                                                                                                Properties
                                                                                                                                                                diff --git a/docs/interfaces/WebAuthorizeOptions.html b/docs/interfaces/WebAuthorizeOptions.html index 93d19fc6..dcf1b07d 100644 --- a/docs/interfaces/WebAuthorizeOptions.html +++ b/docs/interfaces/WebAuthorizeOptions.html @@ -1,705 +1,22 @@ - - - - - - WebAuthorizeOptions | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                -
                                                                                                                                                                - react-native-auth0 - - - - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  Preparing search index...
                                                                                                                                                                  -
                                                                                                                                                                  -                                                                                                                                                                   - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -

                                                                                                                                                                  Interface WebAuthorizeOptions

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - Options for controlling the SDK's behaviour when calling the - /authorize endpoint. -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - interface - WebAuthorizeOptions - {
                                                                                                                                                                      customScheme?: - string;
                                                                                                                                                                      ephemeralSession?: - boolean;
                                                                                                                                                                      leeway?: - number;
                                                                                                                                                                      useLegacyCallbackUrl?: - boolean;
                                                                                                                                                                      useSFSafariViewController?:
                                                                                                                                                                          | - boolean
                                                                                                                                                                          | - { - presentationStyle?: - SafariViewControllerPresentationStyle - };
                                                                                                                                                                  } -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - -
                                                                                                                                                                  Index
                                                                                                                                                                  -                                                                                                                                                                   -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Properties

                                                                                                                                                                  -
                                                                                                                                                                  - - customScheme? - - ephemeralSession? - - leeway? - - useLegacyCallbackUrl? - - useSFSafariViewController? -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - -

                                                                                                                                                                  Properties

                                                                                                                                                                  -                                                                                                                                                                   -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - customScheme?: - string -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  Custom scheme to build the callback URL with.

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - ephemeralSession?: - boolean -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - iOS only: Disable Single-Sign-On (SSO). It - only affects iOS with versions 13 and above. -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -

                                                                                                                                                                  false

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - leeway?: - number -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - The amount of leeway, in seconds, to accommodate potential - clock skew when validating an ID token's claims. -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -

                                                                                                                                                                  60 seconds.

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - useLegacyCallbackUrl?: - boolean -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details. -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  -
                                                                                                                                                                  - -
                                                                                                                                                                  - useSFSafariViewController?:
                                                                                                                                                                      | - boolean
                                                                                                                                                                      | - { - presentationStyle?: - SafariViewControllerPresentationStyle - } -
                                                                                                                                                                  -
                                                                                                                                                                  -

                                                                                                                                                                  - iOS only: Uses - SFSafariViewController instead of - ASWebAuthenticationSession. If empty object is - set, the presentationStyle defaults to <a - href="../enums/SafariViewControllerPresentationStyle.html#fullscreen" - class="tsd-kind-enum-member">SafariViewControllerPresentationStyle.fullScreen</a> -

                                                                                                                                                                  -

                                                                                                                                                                  - This can be used as a boolean value or as an object which sets - the presentationStyle. See the examples below for - reference -

                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  -
                                                                                                                                                                  - - 
                                                                                                                                                                  await authorize({}, {useSFSafariViewController: true});
+WebAuthorizeOptions | react-native-auth0
                                                                                                                                                                  react-native-auth0
                                                                                                                                                                    Preparing search index...
                                                                                                                                                                    Interface WebAuthorizeOptions
                                                                                                                                                                    Options for controlling the SDK's behaviour when calling the /authorize endpoint.
                                                                                                                                                                    
+
                                                                                                                                                                    interface WebAuthorizeOptions {
                                                                                                                                                                        customScheme?: string;
                                                                                                                                                                        ephemeralSession?: boolean;
                                                                                                                                                                        leeway?: number;
                                                                                                                                                                        useLegacyCallbackUrl?: boolean;
                                                                                                                                                                        useSFSafariViewController?:
                                                                                                                                                                            | boolean
                                                                                                                                                                            | { presentationStyle?: SafariViewControllerPresentationStyle };
                                                                                                                                                                    }
                                                                                                                                                                    Index
                                                                                                                                                                    Properties
                                                                                                                                                                    customScheme?
+ephemeralSession?
+leeway?
+useLegacyCallbackUrl?
+useSFSafariViewController?
+
                                                                                                                                                                    Properties
                                                                                                                                                                    customScheme?: string
                                                                                                                                                                    Custom scheme to build the callback URL with.
                                                                                                                                                                    
+
                                                                                                                                                                    ephemeralSession?: boolean
                                                                                                                                                                    iOS only: Disable Single-Sign-On (SSO). It only affects iOS with versions 13 and above.
                                                                                                                                                                    
+
                                                                                                                                                                    false
                                                                                                                                                                    
+
                                                                                                                                                                    leeway?: number
                                                                                                                                                                    The amount of leeway, in seconds, to accommodate potential clock skew when validating an ID token's claims.
                                                                                                                                                                    
+
                                                                                                                                                                    60 seconds.
                                                                                                                                                                    
+
                                                                                                                                                                    useLegacyCallbackUrl?: boolean
                                                                                                                                                                    This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details.
                                                                                                                                                                    
+
                                                                                                                                                                    useSFSafariViewController?:
                                                                                                                                                                        | boolean
                                                                                                                                                                        | { presentationStyle?: SafariViewControllerPresentationStyle }
                                                                                                                                                                    iOS only: Uses SFSafariViewController instead of ASWebAuthenticationSession. If empty object is set, the presentationStyle defaults to <a href="../enums/SafariViewControllerPresentationStyle.html#fullscreen" class="tsd-kind-enum-member">SafariViewControllerPresentationStyle.fullScreen</a>
                                                                                                                                                                    
+
                                                                                                                                                                    This can be used as a boolean value or as an object which sets the presentationStyle. See the examples below for reference
                                                                                                                                                                    
+
                                                                                                                                                                    await authorize({}, {useSFSafariViewController: true});
 
                                                                                                                                                                    
 
-                  
                                                                                                                                                                    or
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  
-                  
                                                                                                                                                                    await authorize({}, {useSFSafariViewController: {presentationStyle: SafariViewControllerPresentationStyle.fullScreen}});
+
                                                                                                                                                                    or
                                                                                                                                                                    
+
                                                                                                                                                                    await authorize({}, {useSFSafariViewController: {presentationStyle: SafariViewControllerPresentationStyle.fullScreen}});
 
                                                                                                                                                                    
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-              
-            
                                                                                                                                                                    
-          
                                                                                                                                                                    
-        
                                                                                                                                                                    
-      
                                                                                                                                                                    
-      
                                                                                                                                                                    
-        
                                                                                                                                                                    
-          
                                                                                                                                                                    
-            
                                                                                                                                                                    
-              
-                
-                
                                                                                                                                                                    Settings
                                                                                                                                                                    
-                                                                                                                                                                                  
-              
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  Member Visibility
-                  
                                                                                                                                                                      
-                    
                                                                                                                                                                    • 
-                      
-                    
                                                                                                                                                                      • 
-                    
                                                                                                                                                                    • 
-                      
-                    
                                                                                                                                                                      • 
-                  
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                
                                                                                                                                                                    
-                  
-                
                                                                                                                                                                    
-              
                                                                                                                                                                    
-            
                                                                                                                                                                    
-          
                                                                                                                                                                    
-          
                                                                                                                                                                    
-            
-              
-              
                                                                                                                                                                    On This Page
                                                                                                                                                                    
-                                                                                                                                                                                
-            
                                                                                                                                                                    
-              
                                                                                                                                                                    
-                
-                  Properties
-                
-                
-              
                                                                                                                                                                    
-            
                                                                                                                                                                    
-          
                                                                                                                                                                    
-        
                                                                                                                                                                    
-        
                                                                                                                                                                    
-          
-        
                                                                                                                                                                    
-      
                                                                                                                                                                    
-    
                                                                                                                                                                    
-    
                                                                                                                                                                    
-      
                                                                                                                                                                    
-        Generated using
-        TypeDoc
-      
                                                                                                                                                                    
-    
                                                                                                                                                                    
-    
                                                                                                                                                                    
-  
-
+
+

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    On This Page

                                                                                                                                                                    Properties
                                                                                                                                                                    diff --git a/docs/interfaces/WebAuthorizeParameters.html b/docs/interfaces/WebAuthorizeParameters.html index 7b167263..fff07b29 100644 --- a/docs/interfaces/WebAuthorizeParameters.html +++ b/docs/interfaces/WebAuthorizeParameters.html @@ -1,907 +1,28 @@ - - - - - - WebAuthorizeParameters | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                    -
                                                                                                                                                                    - react-native-auth0 - - - - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      Preparing search index...
                                                                                                                                                                      -
                                                                                                                                                                      -                                                                                                                                                                       - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -

                                                                                                                                                                      Interface WebAuthorizeParameters

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      - Parameters that are sent to a call to the - /authorize endpoint. -

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - interface - WebAuthorizeParameters - {
                                                                                                                                                                          additionalParameters?: - { - [key: - string]: - string - };
                                                                                                                                                                          audience?: - string;
                                                                                                                                                                          connection?: - string;
                                                                                                                                                                          invitationUrl?: - string;
                                                                                                                                                                          maxAge?: - number;
                                                                                                                                                                          nonce?: - string;
                                                                                                                                                                          organization?: - string;
                                                                                                                                                                          redirectUrl?: - string;
                                                                                                                                                                          scope?: - string;
                                                                                                                                                                          state?: - string;
                                                                                                                                                                      } -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - -
                                                                                                                                                                      Index
                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Properties

                                                                                                                                                                      -
                                                                                                                                                                      - - additionalParameters? - - audience? - - connection? - - invitationUrl? - - maxAge? - - nonce? - - organization? - - redirectUrl? - - scope? - - state? -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - -

                                                                                                                                                                      Properties

                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - additionalParameters?: - { - [key: - string]: - string - } -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      - Any additional arbitrary parameters to send along in the URL. -

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

                                                                                                                                                                      - The intended API identifier that will be the consumer for the - issued access token. -

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

                                                                                                                                                                      The database connection in which to look for users.

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - invitationUrl?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      - The invitation URL for those users who have been invited to - join a specific organization. -

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - maxAge?: - number -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      - The maximum age in seconds that the resulting ID token should - be issued for. -

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - nonce?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      - One-time random value that is used to prevent replay attacks. -

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

                                                                                                                                                                      - The organization in which user's should be authenticated into. -

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - redirectUrl?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      - Specify a custom redirect URL to be used. Normally, you - wouldn't need to call this method manually as the default - value is autogenerated for you. -

                                                                                                                                                                      -

                                                                                                                                                                      - If you are using this, ensure a proper redirect URL is - constructed in the following format Android: - {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback - iOS: - {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -

                                                                                                                                                                      -

                                                                                                                                                                      - If you have useLegacyCallbackUrl set to true then - the redirect URL should in the format Android: - {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback - iOS: - {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback -

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

                                                                                                                                                                      - The scopes requested for the issued tokens. e.g. - openid profile -

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      - state?: - string -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      Random string to prevent CSRF attacks.

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

                                                                                                                                                                      Settings

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

                                                                                                                                                                      On This Page

                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -
                                                                                                                                                                      - - Properties - - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      -

                                                                                                                                                                      - Generated using - TypeDoc -

                                                                                                                                                                      -
                                                                                                                                                                      -
                                                                                                                                                                      - - +WebAuthorizeParameters | react-native-auth0
                                                                                                                                                                      react-native-auth0
                                                                                                                                                                        Preparing search index...

                                                                                                                                                                        Interface WebAuthorizeParameters

                                                                                                                                                                        Parameters that are sent to a call to the /authorize endpoint.

                                                                                                                                                                        +
                                                                                                                                                                        interface WebAuthorizeParameters {
                                                                                                                                                                            additionalParameters?: { [key: string]: string };
                                                                                                                                                                            audience?: string;
                                                                                                                                                                            connection?: string;
                                                                                                                                                                            invitationUrl?: string;
                                                                                                                                                                            maxAge?: number;
                                                                                                                                                                            nonce?: string;
                                                                                                                                                                            organization?: string;
                                                                                                                                                                            redirectUrl?: string;
                                                                                                                                                                            scope?: string;
                                                                                                                                                                            state?: string;
                                                                                                                                                                        }
                                                                                                                                                                        Index

                                                                                                                                                                        Properties

                                                                                                                                                                        additionalParameters? +audience? +connection? +invitationUrl? +maxAge? +nonce? +organization? +redirectUrl? +scope? +state? +

                                                                                                                                                                        Properties

                                                                                                                                                                        additionalParameters?: { [key: string]: string }

                                                                                                                                                                        Any additional arbitrary parameters to send along in the URL.

                                                                                                                                                                        +
                                                                                                                                                                        audience?: string

                                                                                                                                                                        The intended API identifier that will be the consumer for the issued access token.

                                                                                                                                                                        +
                                                                                                                                                                        connection?: string

                                                                                                                                                                        The database connection in which to look for users.

                                                                                                                                                                        +
                                                                                                                                                                        invitationUrl?: string

                                                                                                                                                                        The invitation URL for those users who have been invited to join a specific organization.

                                                                                                                                                                        +
                                                                                                                                                                        maxAge?: number

                                                                                                                                                                        The maximum age in seconds that the resulting ID token should be issued for.

                                                                                                                                                                        +
                                                                                                                                                                        nonce?: string

                                                                                                                                                                        One-time random value that is used to prevent replay attacks.

                                                                                                                                                                        +
                                                                                                                                                                        organization?: string

                                                                                                                                                                        The organization in which user's should be authenticated into.

                                                                                                                                                                        +
                                                                                                                                                                        redirectUrl?: string

                                                                                                                                                                        Specify a custom redirect URL to be used. Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.

                                                                                                                                                                        +

                                                                                                                                                                        If you are using this, ensure a proper redirect URL is constructed in the following format +Android: {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback +iOS: {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                                                                                                                        +

                                                                                                                                                                        If you have useLegacyCallbackUrl set to true then the redirect URL should in the format +Android: {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback +iOS: {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                                                                                                                        +
                                                                                                                                                                        scope?: string

                                                                                                                                                                        The scopes requested for the issued tokens. e.g. openid profile

                                                                                                                                                                        +
                                                                                                                                                                        state?: string

                                                                                                                                                                        Random string to prevent CSRF attacks.

                                                                                                                                                                        +

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility

                                                                                                                                                                        On This Page

                                                                                                                                                                        Properties
                                                                                                                                                                        diff --git a/docs/modules.html b/docs/modules.html index ed6e616a..c92ba012 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,1485 +1 @@ - - - - - - react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                        -
                                                                                                                                                                        - react-native-auth0 - - - - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          Preparing search index...
                                                                                                                                                                          -
                                                                                                                                                                          -                                                                                                                                                                           - -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                          -
                                                                                                                                                                            -

                                                                                                                                                                            react-native-auth0

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Modules

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -
                                                                                                                                                                            - - Types -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Enumerations

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -
                                                                                                                                                                            - - LocalAuthenticationLevel -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LocalAuthenticationStrategy -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - SafariViewControllerPresentationStyle -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Classes

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -
                                                                                                                                                                            - - default -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - TimeoutError -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Interfaces

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -
                                                                                                                                                                            - - AuthorizeUrlOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - ClearSessionOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - ClearSessionParameters -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - CreateUserOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - ExchangeNativeSocialOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - ExchangeOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - GetUserOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LocalAuthenticationOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LoginWithEmailOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LoginWithOOBOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LoginWithOTPOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LoginWithRecoveryCodeOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LoginWithSMSOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - LogoutUrlOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - MultifactorChallengeOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - PasswordlessWithEmailOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - PasswordlessWithSMSOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - PasswordRealmOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - PatchUserOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - RefreshTokenOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - ResetPasswordOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - RevokeOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - UserInfoOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - WebAuthorizeOptions -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - WebAuthorizeParameters -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Type Aliases

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -
                                                                                                                                                                            - - Credentials -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - MultifactorChallengeOOBResponse -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - MultifactorChallengeOOBWithBindingResponse -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - MultifactorChallengeOTPResponse -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - MultifactorChallengeResponse -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - User -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Functions

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -
                                                                                                                                                                            - - Auth0Provider -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - useAuth0 -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - -

                                                                                                                                                                            Settings

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

                                                                                                                                                                            On This Page

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -
                                                                                                                                                                            - - Modules - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - Enumerations - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - Classes - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - Interfaces - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - Type Aliases - - -
                                                                                                                                                                            -
                                                                                                                                                                            - - Functions - - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            -

                                                                                                                                                                            - Generated using - TypeDoc -

                                                                                                                                                                            -
                                                                                                                                                                            -
                                                                                                                                                                            - - +react-native-auth0
                                                                                                                                                                            react-native-auth0
                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                react-native-auth0

                                                                                                                                                                                Modules

                                                                                                                                                                                Types

                                                                                                                                                                                Enumerations

                                                                                                                                                                                LocalAuthenticationLevel
                                                                                                                                                                                LocalAuthenticationStrategy
                                                                                                                                                                                SafariViewControllerPresentationStyle

                                                                                                                                                                                Classes

                                                                                                                                                                                default
                                                                                                                                                                                TimeoutError

                                                                                                                                                                                Interfaces

                                                                                                                                                                                Auth0Options
                                                                                                                                                                                AuthorizeUrlOptions
                                                                                                                                                                                ClearSessionOptions
                                                                                                                                                                                ClearSessionParameters
                                                                                                                                                                                CreateUserOptions
                                                                                                                                                                                ExchangeNativeSocialOptions
                                                                                                                                                                                ExchangeOptions
                                                                                                                                                                                GetUserOptions
                                                                                                                                                                                LocalAuthenticationOptions
                                                                                                                                                                                LoginWithEmailOptions
                                                                                                                                                                                LoginWithOOBOptions
                                                                                                                                                                                LoginWithOTPOptions
                                                                                                                                                                                LoginWithRecoveryCodeOptions
                                                                                                                                                                                LoginWithSMSOptions
                                                                                                                                                                                LogoutUrlOptions
                                                                                                                                                                                MultifactorChallengeOptions
                                                                                                                                                                                PasswordlessWithEmailOptions
                                                                                                                                                                                PasswordlessWithSMSOptions
                                                                                                                                                                                PasswordRealmOptions
                                                                                                                                                                                PatchUserOptions
                                                                                                                                                                                RefreshTokenOptions
                                                                                                                                                                                ResetPasswordOptions
                                                                                                                                                                                RevokeOptions
                                                                                                                                                                                UserInfoOptions
                                                                                                                                                                                WebAuthorizeOptions
                                                                                                                                                                                WebAuthorizeParameters

                                                                                                                                                                                Type Aliases

                                                                                                                                                                                Credentials
                                                                                                                                                                                MultifactorChallengeOOBResponse
                                                                                                                                                                                MultifactorChallengeOOBWithBindingResponse
                                                                                                                                                                                MultifactorChallengeOTPResponse
                                                                                                                                                                                MultifactorChallengeResponse
                                                                                                                                                                                User

                                                                                                                                                                                Functions

                                                                                                                                                                                Auth0Provider
                                                                                                                                                                                useAuth0

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility

                                                                                                                                                                                On This Page

                                                                                                                                                                                Modules
                                                                                                                                                                                Enumerations
                                                                                                                                                                                Classes
                                                                                                                                                                                Interfaces
                                                                                                                                                                                Type Aliases
                                                                                                                                                                                Functions
                                                                                                                                                                                diff --git a/docs/modules/Types.html b/docs/modules/Types.html index 675e86b9..059e1fdf 100644 --- a/docs/modules/Types.html +++ b/docs/modules/Types.html @@ -1,563 +1 @@ - - - - - - Types | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                -
                                                                                                                                                                                - react-native-auth0 - - - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                  -
                                                                                                                                                                                  -                                                                                                                                                                                   - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -

                                                                                                                                                                                  Module Types

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  Classes

                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Auth -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - BaseError -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - CredentialsManager -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Users -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - WebAuth -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  Interfaces

                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Auth0ContextInterface -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - AuthState -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Auth0Response -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Telemetry -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - -

                                                                                                                                                                                  Settings

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

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  -                                                                                                                                                                                   -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Classes - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Interfaces - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - Type Aliases - - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  -

                                                                                                                                                                                  - Generated using - TypeDoc -

                                                                                                                                                                                  -
                                                                                                                                                                                  -
                                                                                                                                                                                  - - +Types | react-native-auth0
                                                                                                                                                                                  react-native-auth0
                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                    Module Types

                                                                                                                                                                                    Classes

                                                                                                                                                                                    Auth
                                                                                                                                                                                    BaseError
                                                                                                                                                                                    CredentialsManager
                                                                                                                                                                                    Users
                                                                                                                                                                                    WebAuth

                                                                                                                                                                                    Interfaces

                                                                                                                                                                                    Auth0ContextInterface
                                                                                                                                                                                    AuthState

                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                    Auth0Response
                                                                                                                                                                                    Telemetry

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                    On This Page

                                                                                                                                                                                    Classes
                                                                                                                                                                                    Interfaces
                                                                                                                                                                                    Type Aliases
                                                                                                                                                                                    diff --git a/docs/types/Credentials.html b/docs/types/Credentials.html index b5d31ccd..bdf93257 100644 --- a/docs/types/Credentials.html +++ b/docs/types/Credentials.html @@ -1,657 +1,13 @@ - - - - - - Credentials | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                    -
                                                                                                                                                                                    - react-native-auth0 - - - - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                      -
                                                                                                                                                                                      -                                                                                                                                                                                       - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -

                                                                                                                                                                                      Type Alias Credentials

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - type - Credentials - = - {
                                                                                                                                                                                          accessToken: - string;
                                                                                                                                                                                          expiresAt: - number;
                                                                                                                                                                                          idToken: - string;
                                                                                                                                                                                          refreshToken?: - string;
                                                                                                                                                                                          scope?: - string;
                                                                                                                                                                                          tokenType: - string;
                                                                                                                                                                                          [key: - string]: - any;
                                                                                                                                                                                      } -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      Indexable

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

                                                                                                                                                                                      Properties

                                                                                                                                                                                      -
                                                                                                                                                                                      - - accessToken - - expiresAt - - idToken - - refreshToken? - - scope? - - tokenType -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - - -

                                                                                                                                                                                      Properties

                                                                                                                                                                                      -                                                                                                                                                                                       -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      - accessToken: - string -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      The token used to make API calls

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      - expiresAt: - number -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      - Used to denote when the token will expire, as a UNIX timestamp -

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      - idToken: - string -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      A token in JWT format that has user claims

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      - refreshToken?: - string -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      The token used to refresh the access token

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

                                                                                                                                                                                      Represents the scope of the current token

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      - tokenType: - string -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      The type of the token, e.g.: Bearer

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

                                                                                                                                                                                      Settings

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

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      -                                                                                                                                                                                       -
                                                                                                                                                                                      -
                                                                                                                                                                                      - - Properties - - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      -

                                                                                                                                                                                      - Generated using - TypeDoc -

                                                                                                                                                                                      -
                                                                                                                                                                                      -
                                                                                                                                                                                      - - +Credentials | react-native-auth0
                                                                                                                                                                                      react-native-auth0
                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                        Type Alias Credentials

                                                                                                                                                                                        type Credentials = {
                                                                                                                                                                                            accessToken: string;
                                                                                                                                                                                            expiresAt: number;
                                                                                                                                                                                            idToken: string;
                                                                                                                                                                                            refreshToken?: string;
                                                                                                                                                                                            scope?: string;
                                                                                                                                                                                            tokenType: string;
                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                        }

                                                                                                                                                                                        Indexable

                                                                                                                                                                                        • [key: string]: any
                                                                                                                                                                                        Index

                                                                                                                                                                                        Properties

                                                                                                                                                                                        accessToken +expiresAt +idToken +refreshToken? +scope? +tokenType +

                                                                                                                                                                                        Properties

                                                                                                                                                                                        accessToken: string

                                                                                                                                                                                        The token used to make API calls

                                                                                                                                                                                        +
                                                                                                                                                                                        expiresAt: number

                                                                                                                                                                                        Used to denote when the token will expire, as a UNIX timestamp

                                                                                                                                                                                        +
                                                                                                                                                                                        idToken: string

                                                                                                                                                                                        A token in JWT format that has user claims

                                                                                                                                                                                        +
                                                                                                                                                                                        refreshToken?: string

                                                                                                                                                                                        The token used to refresh the access token

                                                                                                                                                                                        +
                                                                                                                                                                                        scope?: string

                                                                                                                                                                                        Represents the scope of the current token

                                                                                                                                                                                        +
                                                                                                                                                                                        tokenType: string

                                                                                                                                                                                        The type of the token, e.g.: Bearer

                                                                                                                                                                                        +

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                        On This Page

                                                                                                                                                                                        Properties
                                                                                                                                                                                        diff --git a/docs/types/MultifactorChallengeOOBResponse.html b/docs/types/MultifactorChallengeOOBResponse.html index a0ea7bb1..55c002ce 100644 --- a/docs/types/MultifactorChallengeOOBResponse.html +++ b/docs/types/MultifactorChallengeOOBResponse.html @@ -1,242 +1 @@ - - - - - - MultifactorChallengeOOBResponse | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                        -
                                                                                                                                                                                        - react-native-auth0 - - - - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                          -
                                                                                                                                                                                          -                                                                                                                                                                                           - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - -

                                                                                                                                                                                          Type Alias MultifactorChallengeOOBResponse

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - MultifactorChallengeOOBResponse: - MultifactorChallengeOTPResponse - & - {
                                                                                                                                                                                              oobCode: - string;
                                                                                                                                                                                          } -
                                                                                                                                                                                          - -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - -

                                                                                                                                                                                          Settings

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

                                                                                                                                                                                          - Generated using - TypeDoc -

                                                                                                                                                                                          -
                                                                                                                                                                                          -
                                                                                                                                                                                          - - +MultifactorChallengeOOBResponse | react-native-auth0
                                                                                                                                                                                          react-native-auth0
                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                            Type Alias MultifactorChallengeOOBResponse

                                                                                                                                                                                            MultifactorChallengeOOBResponse: MultifactorChallengeOTPResponse & {
                                                                                                                                                                                                oobCode: string;
                                                                                                                                                                                            }

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            diff --git a/docs/types/MultifactorChallengeOOBWithBindingResponse.html b/docs/types/MultifactorChallengeOOBWithBindingResponse.html index 7759e781..7fd6ae0c 100644 --- a/docs/types/MultifactorChallengeOOBWithBindingResponse.html +++ b/docs/types/MultifactorChallengeOOBWithBindingResponse.html @@ -1,246 +1 @@ - - - - - - - MultifactorChallengeOOBWithBindingResponse | react-native-auth0 - - - - - - - - - - - - - -
                                                                                                                                                                                            -
                                                                                                                                                                                            - react-native-auth0 - - - - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                              -
                                                                                                                                                                                              -                                                                                                                                                                                               - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - -

                                                                                                                                                                                              Type Alias MultifactorChallengeOOBWithBindingResponse

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - MultifactorChallengeOOBWithBindingResponse: - MultifactorChallengeOOBResponse - & - {
                                                                                                                                                                                                  bindingMethod: - string;
                                                                                                                                                                                              } -
                                                                                                                                                                                              - -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - -

                                                                                                                                                                                              Settings

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

                                                                                                                                                                                              - Generated using - TypeDoc -

                                                                                                                                                                                              -
                                                                                                                                                                                              -
                                                                                                                                                                                              - - +MultifactorChallengeOOBWithBindingResponse | react-native-auth0
                                                                                                                                                                                              react-native-auth0
                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                Type Alias MultifactorChallengeOOBWithBindingResponse

                                                                                                                                                                                                MultifactorChallengeOOBWithBindingResponse: MultifactorChallengeOOBResponse & {
                                                                                                                                                                                                    bindingMethod: string;
                                                                                                                                                                                                }

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                diff --git a/docs/types/MultifactorChallengeOTPResponse.html b/docs/types/MultifactorChallengeOTPResponse.html index 1ab08471..dbfa8002 100644 --- a/docs/types/MultifactorChallengeOTPResponse.html +++ b/docs/types/MultifactorChallengeOTPResponse.html @@ -1,360 +1,2 @@ - - - - - - MultifactorChallengeOTPResponse | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                                -
                                                                                                                                                                                                - react-native-auth0 - - - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -                                                                                                                                                                                                   - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -

                                                                                                                                                                                                  Type Alias MultifactorChallengeOTPResponse

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - type - MultifactorChallengeOTPResponse - = - {
                                                                                                                                                                                                      challengeType: - string;
                                                                                                                                                                                                  } -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -
                                                                                                                                                                                                  Index
                                                                                                                                                                                                  -                                                                                                                                                                                                   -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - challengeType -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -

                                                                                                                                                                                                  Properties

                                                                                                                                                                                                  -                                                                                                                                                                                                   -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  - challengeType: - string -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - -

                                                                                                                                                                                                  Settings

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

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  -                                                                                                                                                                                                   -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - Properties - - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  -

                                                                                                                                                                                                  - Generated using - TypeDoc -

                                                                                                                                                                                                  -
                                                                                                                                                                                                  -
                                                                                                                                                                                                  - - +MultifactorChallengeOTPResponse | react-native-auth0
                                                                                                                                                                                                  react-native-auth0
                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                    Type Alias MultifactorChallengeOTPResponse

                                                                                                                                                                                                    type MultifactorChallengeOTPResponse = {
                                                                                                                                                                                                        challengeType: string;
                                                                                                                                                                                                    }
                                                                                                                                                                                                    Index

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    challengeType +

                                                                                                                                                                                                    Properties

                                                                                                                                                                                                    challengeType: string

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                    Properties
                                                                                                                                                                                                    diff --git a/docs/types/MultifactorChallengeResponse.html b/docs/types/MultifactorChallengeResponse.html index 6cc0db26..1d9ed8c0 100644 --- a/docs/types/MultifactorChallengeResponse.html +++ b/docs/types/MultifactorChallengeResponse.html @@ -1,244 +1 @@ - - - - - - MultifactorChallengeResponse | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                                    -
                                                                                                                                                                                                    - react-native-auth0 - - - - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -                                                                                                                                                                                                       - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      Type Alias MultifactorChallengeResponse

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - MultifactorChallengeResponse:
                                                                                                                                                                                                          | - MultifactorChallengeOTPResponse
                                                                                                                                                                                                          | - MultifactorChallengeOOBResponse
                                                                                                                                                                                                          | - MultifactorChallengeOOBWithBindingResponse -
                                                                                                                                                                                                      - -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - -

                                                                                                                                                                                                      Settings

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

                                                                                                                                                                                                      - Generated using - TypeDoc -

                                                                                                                                                                                                      -
                                                                                                                                                                                                      -
                                                                                                                                                                                                      - - +MultifactorChallengeResponse | react-native-auth0
                                                                                                                                                                                                      react-native-auth0
                                                                                                                                                                                                        Preparing search index...

                                                                                                                                                                                                        Type Alias MultifactorChallengeResponse

                                                                                                                                                                                                        MultifactorChallengeResponse:
                                                                                                                                                                                                            | MultifactorChallengeOTPResponse
                                                                                                                                                                                                            | MultifactorChallengeOOBResponse
                                                                                                                                                                                                            | MultifactorChallengeOOBWithBindingResponse

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                        diff --git a/docs/types/Types.Auth0Response.html b/docs/types/Types.Auth0Response.html index f912079c..96475825 100644 --- a/docs/types/Types.Auth0Response.html +++ b/docs/types/Types.Auth0Response.html @@ -1,571 +1,6 @@ - - - - - - Auth0Response | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                                        -
                                                                                                                                                                                                        - react-native-auth0 - - - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          Preparing search index...
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -                                                                                                                                                                                                           - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          Type Alias Auth0Response<TData>

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - type - Auth0Response<TData> - = - {
                                                                                                                                                                                                              headers?: - Headers;
                                                                                                                                                                                                              json?: - TData;
                                                                                                                                                                                                              ok?: - boolean;
                                                                                                                                                                                                              status: - number;
                                                                                                                                                                                                              text?: - string;
                                                                                                                                                                                                          } -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                          -
                                                                                                                                                                                                            -
                                                                                                                                                                                                          • - TData -
                                                                                                                                                                                                            • -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -
                                                                                                                                                                                                          Index
                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - headers? - - json? - - ok? - - status - - text? -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -

                                                                                                                                                                                                          Properties

                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          - headers?: - Headers -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          - json?: - TData -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          - ok?: - boolean -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          - status: - number -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          - Optionaltext -

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - text?: - string -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - -

                                                                                                                                                                                                          Settings

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

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - Properties - - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          - Generated using - TypeDoc -

                                                                                                                                                                                                          -
                                                                                                                                                                                                          -
                                                                                                                                                                                                          - - +Auth0Response | react-native-auth0
                                                                                                                                                                                                          react-native-auth0
                                                                                                                                                                                                            Preparing search index...

                                                                                                                                                                                                            Type Alias Auth0Response<TData>

                                                                                                                                                                                                            type Auth0Response<TData> = {
                                                                                                                                                                                                                headers?: Headers;
                                                                                                                                                                                                                json?: TData;
                                                                                                                                                                                                                ok?: boolean;
                                                                                                                                                                                                                status: number;
                                                                                                                                                                                                                text?: string;
                                                                                                                                                                                                            }

                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                            • TData
                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            headers? +json? +ok? +status +text? +

                                                                                                                                                                                                            Properties

                                                                                                                                                                                                            headers?: Headers
                                                                                                                                                                                                            json?: TData
                                                                                                                                                                                                            ok?: boolean
                                                                                                                                                                                                            status: number

                                                                                                                                                                                                            Optionaltext

                                                                                                                                                                                                            text?: string

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                            Properties
                                                                                                                                                                                                            diff --git a/docs/types/Types.Telemetry.html b/docs/types/Types.Telemetry.html index eafb9390..5c64be31 100644 --- a/docs/types/Types.Telemetry.html +++ b/docs/types/Types.Telemetry.html @@ -1,453 +1,4 @@ - - - - - - Telemetry | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                                            -
                                                                                                                                                                                                            - react-native-auth0 - - - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              Preparing search index...
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -                                                                                                                                                                                                               - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -

                                                                                                                                                                                                              Type Alias Telemetry

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - type - Telemetry - = - {
                                                                                                                                                                                                                  env?: - any;
                                                                                                                                                                                                                  name?: - string;
                                                                                                                                                                                                                  version?: - string;
                                                                                                                                                                                                              } -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -
                                                                                                                                                                                                              Index
                                                                                                                                                                                                              -                                                                                                                                                                                                               -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - env? - - name? - - version? -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -

                                                                                                                                                                                                              Properties

                                                                                                                                                                                                              -                                                                                                                                                                                                               -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              - env?: - any -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              - name?: - string -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              - version?: - string -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - -

                                                                                                                                                                                                              Settings

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

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              -                                                                                                                                                                                                               -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - Properties - - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              -

                                                                                                                                                                                                              - Generated using - TypeDoc -

                                                                                                                                                                                                              -
                                                                                                                                                                                                              -
                                                                                                                                                                                                              - - +Telemetry | react-native-auth0
                                                                                                                                                                                                              react-native-auth0
                                                                                                                                                                                                                Preparing search index...

                                                                                                                                                                                                                Type Alias Telemetry

                                                                                                                                                                                                                type Telemetry = {
                                                                                                                                                                                                                    env?: any;
                                                                                                                                                                                                                    name?: string;
                                                                                                                                                                                                                    version?: string;
                                                                                                                                                                                                                }
                                                                                                                                                                                                                Index

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                env? +name? +version? +

                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                env?: any
                                                                                                                                                                                                                name?: string
                                                                                                                                                                                                                version?: string

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                Properties
                                                                                                                                                                                                                diff --git a/docs/types/User.html b/docs/types/User.html index e143e0b1..a12e9254 100644 --- a/docs/types/User.html +++ b/docs/types/User.html @@ -1,1346 +1,21 @@ - - - - - - User | react-native-auth0 - - - - - - - - - - - - -
                                                                                                                                                                                                                -
                                                                                                                                                                                                                - react-native-auth0 - - - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -                                                                                                                                                                                                                   - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                  Type Alias User

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - type - User - = - {
                                                                                                                                                                                                                      address?: - string;
                                                                                                                                                                                                                      birthdate?: - string;
                                                                                                                                                                                                                      email?: - string;
                                                                                                                                                                                                                      emailVerified?: - boolean;
                                                                                                                                                                                                                      familyName?: - string;
                                                                                                                                                                                                                      gender?: - string;
                                                                                                                                                                                                                      givenName?: - string;
                                                                                                                                                                                                                      locale?: - string;
                                                                                                                                                                                                                      middleName?: - string;
                                                                                                                                                                                                                      name?: - string;
                                                                                                                                                                                                                      nickname?: - string;
                                                                                                                                                                                                                      phoneNumber?: - string;
                                                                                                                                                                                                                      phoneNumberVerified?: - boolean;
                                                                                                                                                                                                                      picture?: - string;
                                                                                                                                                                                                                      preferredUsername?: - string;
                                                                                                                                                                                                                      profile?: - string;
                                                                                                                                                                                                                      sub?: - string;
                                                                                                                                                                                                                      updatedAt?: - string;
                                                                                                                                                                                                                      website?: - string;
                                                                                                                                                                                                                      zoneinfo?: - string;
                                                                                                                                                                                                                      [key: - string]: - any;
                                                                                                                                                                                                                  } -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  Indexable

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

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - address? - - birthdate? - - email? - - emailVerified? - - familyName? - - gender? - - givenName? - - locale? - - middleName? - - name? - - nickname? - - phoneNumber? - - phoneNumberVerified? - - picture? - - preferredUsername? - - profile? - - sub? - - updatedAt? - - website? - - zoneinfo? -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                  -                                                                                                                                                                                                                   -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - address?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - birthdate?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - email?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - emailVerified?: - boolean -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - familyName?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - gender?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - givenName?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - locale?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - middleName?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - name?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - nickname?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - phoneNumber?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - phoneNumberVerified?: - boolean -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - picture?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - preferredUsername?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - profile?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - sub?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - updatedAt?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - website?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  - zoneinfo?: - string -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - -

                                                                                                                                                                                                                  Settings

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

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  -                                                                                                                                                                                                                   -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - Properties - - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                  - Generated using - TypeDoc -

                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  -
                                                                                                                                                                                                                  - - +User | react-native-auth0
                                                                                                                                                                                                                  react-native-auth0
                                                                                                                                                                                                                    Preparing search index...

                                                                                                                                                                                                                    Type Alias User

                                                                                                                                                                                                                    type User = {
                                                                                                                                                                                                                        address?: string;
                                                                                                                                                                                                                        birthdate?: string;
                                                                                                                                                                                                                        email?: string;
                                                                                                                                                                                                                        emailVerified?: boolean;
                                                                                                                                                                                                                        familyName?: string;
                                                                                                                                                                                                                        gender?: string;
                                                                                                                                                                                                                        givenName?: string;
                                                                                                                                                                                                                        locale?: string;
                                                                                                                                                                                                                        middleName?: string;
                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                        nickname?: string;
                                                                                                                                                                                                                        phoneNumber?: string;
                                                                                                                                                                                                                        phoneNumberVerified?: boolean;
                                                                                                                                                                                                                        picture?: string;
                                                                                                                                                                                                                        preferredUsername?: string;
                                                                                                                                                                                                                        profile?: string;
                                                                                                                                                                                                                        sub?: string;
                                                                                                                                                                                                                        updatedAt?: string;
                                                                                                                                                                                                                        website?: string;
                                                                                                                                                                                                                        zoneinfo?: string;
                                                                                                                                                                                                                        [key: string]: any;
                                                                                                                                                                                                                    }

                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                    • [key: string]: any
                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    address? +birthdate? +email? +emailVerified? +familyName? +gender? +givenName? +locale? +middleName? +name? +nickname? +phoneNumber? +phoneNumberVerified? +picture? +preferredUsername? +profile? +sub? +updatedAt? +website? +zoneinfo? +

                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                    address?: string
                                                                                                                                                                                                                    birthdate?: string
                                                                                                                                                                                                                    email?: string
                                                                                                                                                                                                                    emailVerified?: boolean
                                                                                                                                                                                                                    familyName?: string
                                                                                                                                                                                                                    gender?: string
                                                                                                                                                                                                                    givenName?: string
                                                                                                                                                                                                                    locale?: string
                                                                                                                                                                                                                    middleName?: string
                                                                                                                                                                                                                    name?: string
                                                                                                                                                                                                                    nickname?: string
                                                                                                                                                                                                                    phoneNumber?: string
                                                                                                                                                                                                                    phoneNumberVerified?: boolean
                                                                                                                                                                                                                    picture?: string
                                                                                                                                                                                                                    preferredUsername?: string
                                                                                                                                                                                                                    profile?: string
                                                                                                                                                                                                                    sub?: string
                                                                                                                                                                                                                    updatedAt?: string
                                                                                                                                                                                                                    website?: string
                                                                                                                                                                                                                    zoneinfo?: string

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                    Properties
                                                                                                                                                                                                                    diff --git a/package-lock.json b/package-lock.json index 10dfe583..7d6c2928 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "react-native-auth0", - "version": "4.5.0", + "version": "4.6.0", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "react-native-auth0", - "version": "4.5.0", + "version": "4.6.0", "license": "MIT", "dependencies": { "base-64": "^0.1.0", diff --git a/package.json b/package.json index 4340bab9..9c0e7a0f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "react-native-auth0", "title": "React Native Auth0", - "version": "4.5.0", + "version": "4.6.0", "description": "React Native toolkit for Auth0 API", "main": "lib/commonjs/index.js", "module": "lib/module/index.js", From 5c750801d3a9353ef425ae32dd9e981179f99624 Mon Sep 17 00:00:00 2001 From: Subhankar Maiti Date: Fri, 2 May 2025 10:28:42 +0530 Subject: [PATCH 2/2] formated doc with prettier --- docs/assets/hierarchy.js | 3 +- docs/assets/highlight.css | 169 +- docs/assets/icons.js | 37 +- docs/assets/main.js | 2532 ++++++++++++- docs/assets/navigation.js | 3 +- docs/assets/search.js | 3 +- docs/assets/style.css | 3159 ++++++++--------- docs/classes/TimeoutError.html | 503 ++- docs/classes/Types.Auth.html | 2631 +++++++++++++- docs/classes/Types.BaseError.html | 518 ++- docs/classes/Types.CredentialsManager.html | 784 +++- docs/classes/Types.Users.html | 704 +++- docs/classes/Types.WebAuth.html | 725 +++- docs/classes/default.html | 838 ++++- docs/enums/LocalAuthenticationLevel.html | 472 ++- docs/enums/LocalAuthenticationStrategy.html | 423 ++- ...SafariViewControllerPresentationStyle.html | 779 +++- docs/functions/Auth0Provider.html | 453 ++- docs/functions/useAuth0.html | 283 +- docs/hierarchy.html | 254 +- docs/index.html | 2144 +++++++++-- docs/interfaces/Auth0Options.html | 679 +++- docs/interfaces/AuthorizeUrlOptions.html | 510 ++- docs/interfaces/ClearSessionOptions.html | 441 ++- docs/interfaces/ClearSessionParameters.html | 487 ++- docs/interfaces/CreateUserOptions.html | 972 ++++- .../ExchangeNativeSocialOptions.html | 701 +++- docs/interfaces/ExchangeOptions.html | 516 ++- docs/interfaces/GetUserOptions.html | 443 ++- .../LocalAuthenticationOptions.html | 818 ++++- docs/interfaces/LoginWithEmailOptions.html | 623 +++- docs/interfaces/LoginWithOOBOptions.html | 580 ++- docs/interfaces/LoginWithOTPOptions.html | 574 ++- .../LoginWithRecoveryCodeOptions.html | 517 ++- docs/interfaces/LoginWithSMSOptions.html | 625 +++- docs/interfaces/LogoutUrlOptions.html | 516 ++- .../MultifactorChallengeOptions.html | 583 ++- docs/interfaces/PasswordRealmOptions.html | 689 +++- .../PasswordlessWithEmailOptions.html | 569 ++- .../PasswordlessWithSMSOptions.html | 572 ++- docs/interfaces/PatchUserOptions.html | 495 ++- docs/interfaces/RefreshTokenOptions.html | 515 ++- docs/interfaces/ResetPasswordOptions.html | 512 ++- docs/interfaces/RevokeOptions.html | 458 ++- .../Types.Auth0ContextInterface.html | 2731 +++++++++++++- docs/interfaces/Types.AuthState.html | 556 ++- docs/interfaces/UserInfoOptions.html | 433 ++- docs/interfaces/WebAuthorizeOptions.html | 721 +++- docs/interfaces/WebAuthorizeParameters.html | 935 ++++- docs/modules.html | 1512 +++++++- docs/modules/Types.html | 564 ++- docs/types/Credentials.html | 670 +++- .../MultifactorChallengeOOBResponse.html | 243 +- ...factorChallengeOOBWithBindingResponse.html | 247 +- .../MultifactorChallengeOTPResponse.html | 362 +- docs/types/MultifactorChallengeResponse.html | 245 +- docs/types/Types.Auth0Response.html | 577 ++- docs/types/Types.Telemetry.html | 457 ++- docs/types/User.html | 1367 ++++++- 59 files changed, 39773 insertions(+), 2659 deletions(-) diff --git a/docs/assets/hierarchy.js b/docs/assets/hierarchy.js index 715d5f90..8882c055 100644 --- a/docs/assets/hierarchy.js +++ b/docs/assets/hierarchy.js @@ -1 +1,2 @@ -window.hierarchyData = "eJyNj8FqwzAQRP9lzkraCNexdGtLDz23N+ODsDdYRJaKtIaW4H8vrrFxQkNyWtid4b09IYbACbrMVCbkXlUCkQ6OarbBJ+gTpFTj8KYjaHzajkLPbzGGCIGj9Q30ThYCfXTQqJ1JidLDOrdtuXMQ0w0anJrNWNxMi0FA7teMF5PoNuDni9J2id5gCNStdU0kD11KqaoRWuQr6HPP7eNr8Ezf/O6Z4sHUtAjIp3wWsPNxdvi3edVnqY9/Zyq7UPhgw/dj/9J3oM7fL/JqGIZf7LeoRQ==" \ No newline at end of file +window.hierarchyData = + 'eJyNj8FqwzAQRP9lzkraCNexdGtLDz23N+ODsDdYRJaKtIaW4H8vrrFxQkNyWtid4b09IYbACbrMVCbkXlUCkQ6OarbBJ+gTpFTj8KYjaHzajkLPbzGGCIGj9Q30ThYCfXTQqJ1JidLDOrdtuXMQ0w0anJrNWNxMi0FA7teMF5PoNuDni9J2id5gCNStdU0kD11KqaoRWuQr6HPP7eNr8Ezf/O6Z4sHUtAjIp3wWsPNxdvi3edVnqY9/Zyq7UPhgw/dj/9J3oM7fL/JqGIZf7LeoRQ=='; diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 08546cc8..46cbe9e9 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -1,33 +1,34 @@ :root { - --light-hl-0: #000000; - --dark-hl-0: #C8C8C8; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #001080; - --dark-hl-2: #9CDCFE; - --light-hl-3: #A31515; - --dark-hl-3: #CE9178; - --light-hl-4: #0451A5; - --dark-hl-4: #9CDCFE; - --light-hl-5: #CD3131; - --dark-hl-5: #F44747; - --light-hl-6: #AF00DB; - --dark-hl-6: #C586C0; - --light-hl-7: #0000FF; - --dark-hl-7: #569CD6; - --light-hl-8: #0070C1; - --dark-hl-8: #4FC1FF; - --light-hl-9: #008000; - --dark-hl-9: #6A9955; - --light-hl-10: #795E26; - --dark-hl-10: #DCDCAA; - --light-hl-11: #267F99; - --dark-hl-11: #4EC9B0; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; + --light-hl-0: #000000; + --dark-hl-0: #c8c8c8; + --light-hl-1: #000000; + --dark-hl-1: #d4d4d4; + --light-hl-2: #001080; + --dark-hl-2: #9cdcfe; + --light-hl-3: #a31515; + --dark-hl-3: #ce9178; + --light-hl-4: #0451a5; + --dark-hl-4: #9cdcfe; + --light-hl-5: #cd3131; + --dark-hl-5: #f44747; + --light-hl-6: #af00db; + --dark-hl-6: #c586c0; + --light-hl-7: #0000ff; + --dark-hl-7: #569cd6; + --light-hl-8: #0070c1; + --dark-hl-8: #4fc1ff; + --light-hl-9: #008000; + --dark-hl-9: #6a9955; + --light-hl-10: #795e26; + --dark-hl-10: #dcdcaa; + --light-hl-11: #267f99; + --dark-hl-11: #4ec9b0; + --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); @@ -41,9 +42,11 @@ --hl-10: var(--light-hl-10); --hl-11: var(--light-hl-11); --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); @@ -57,50 +60,78 @@ --hl-10: var(--dark-hl-10); --hl-11: var(--dark-hl-11); --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); - --hl-11: var(--light-hl-11); - --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); + --hl-11: var(--light-hl-11); + --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); - --hl-11: var(--dark-hl-11); - --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); + --hl-11: var(--dark-hl-11); + --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); } -.hl-11 { color: var(--hl-11); } -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); +} +.hl-11 { + color: var(--hl-11); +} +pre, +code { + background: var(--code-background); +} diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 58882d76..20caa56f 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -1,18 +1,21 @@ -(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(/.*#/, "#")); - } - }); - } -})() \ No newline at end of file + function updateUseElements() { + document.querySelectorAll('use').forEach((el) => { + if (el.getAttribute('href').includes('#icon-')) { + el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); + } + }); + } +})(); diff --git a/docs/assets/main.js b/docs/assets/main.js index 3effabb2..187af7cf 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,9 +1,2529 @@ -"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 Je=Object.create;var he=Object.defineProperty;var Ke=Object.getOwnPropertyDescriptor;var Ge=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var Ze=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var et=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ge(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ke(e,i))||r.enumerable});return t};var tt=(t,e,n)=>(n=t!=null?Je(Xe(t)):{},et(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=Ze((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)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default: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 O,G={getItem(){return null},setItem(){}},K;try{K=localStorage,O=K}catch{K=G,O=G}var S={getItem:t=>O.getItem(t),setItem:(t,e)=>O.setItem(t,e),disableWritingLocalStorage(){O=G},disable(){localStorage.clear(),O=G},enable(){O=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 Y(t,e){pe.push({selector:e,constructor:t})}var X=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&&!nt(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 nt(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=tt(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 Z="closing",ae="tsd-overlay";function rt(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function it(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Z)&&(t.classList.remove(Z),document.getElementById(ae)?.remove(),t.close(),it())}),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(),rt()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Z),t.classList.add(Z)}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),st({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function st(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(()=>{ot(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&&!ct()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function ot(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;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:${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 at={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>at[e])}function Pe(t,e){t.innerHTML=e?`
                                                                                                                                                                                                                    ${e}
                                                                                                                                                                                                                    `:""}var lt=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ct(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!lt.includes(t.type):!1}var D="mousedown",Oe="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,ut=!1,F=!1,Me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Me?"is-mobile":"not-mobile");Me&&"ontouchstart"in document.documentElement&&(ut=!0,D="touchstart",Oe="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(Oe,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 Fe(){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)Ne(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ne(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)Ne(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(document.createElement("span")).textContent=t.text}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(document.createElement("span")).textContent=t.text}}var oe=document.documentElement.dataset.base;oe.endsWith("/")||(oe+="/");function Ve(){document.querySelector(".tsd-full-hierarchy")?dt():document.querySelector(".tsd-hierarchy")&&ht()}function dt(){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=mt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function ht(){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"),pt(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 pt(t,e,n){let r=e.roots.filter(i=>ft(e,i,n));for(let i of r)t.appendChild($e(e,i,n))}function $e(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=$e(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function ft(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 mt(){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}Y(re,"a[data-toggle]");Y(ie,".tsd-accordion");Y(ee,".tsd-filter-item input[type=checkbox]");var je=document.getElementById("tsd-theme");je&&He(je);var gt=new X;Object.defineProperty(window,"app",{value:gt});_e();Fe();Ve();"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 Je = Object.create; + var he = Object.defineProperty; + var Ke = Object.getOwnPropertyDescriptor; + var Ge = Object.getOwnPropertyNames; + var Xe = Object.getPrototypeOf, + Ye = Object.prototype.hasOwnProperty; + var Ze = (t, e) => () => ( + e || t((e = { exports: {} }).exports, e), e.exports + ); + var et = (t, e, n, r) => { + if ((e && typeof e == 'object') || typeof e == 'function') + for (let i of Ge(e)) + !Ye.call(t, i) && + i !== n && + he(t, i, { + get: () => e[i], + enumerable: !(r = Ke(e, i)) || r.enumerable, + }); + return t; + }; + var tt = (t, e, n) => ( + (n = t != null ? Je(Xe(t)) : {}), + et( + e || !t || !t.__esModule + ? he(n, 'default', { value: t, enumerable: !0 }) + : n, + t + ) + ); + var ye = Ze((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)$/, + M = 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 = M), + (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], M = 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(M, l.boost, function (ze, Ue) { + return ze + Ue; + }), + !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 (qe, We) { + return We.score - qe.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, + M; + 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), + (M = Math.round(C * 1e3) / 1e3), + l.insert(T, M); + } + 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); + } + switch (s.type) { + case t.QueryLexer.TERM: + return t.QueryParser.parseTerm; + default: + 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 O, + G = { + getItem() { + return null; + }, + setItem() {}, + }, + K; + try { + (K = localStorage), (O = K); + } catch { + (K = G), (O = G); + } + var S = { + getItem: (t) => O.getItem(t), + setItem: (t, e) => O.setItem(t, e), + disableWritingLocalStorage() { + O = G; + }, + disable() { + localStorage.clear(), (O = G); + }, + enable() { + O = 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 Y(t, e) { + pe.push({ selector: e, constructor: t }); + } + var X = 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 && !nt(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 nt(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 = tt(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 Z = 'closing', + ae = 'tsd-overlay'; + function rt() { + let t = Math.abs(window.innerWidth - document.documentElement.clientWidth); + (document.body.style.overflow = 'hidden'), + (document.body.style.paddingRight = `${t}px`); + } + function it() { + document.body.style.removeProperty('overflow'), + document.body.style.removeProperty('padding-right'); + } + function xe(t, e) { + t.addEventListener('animationend', () => { + t.classList.contains(Z) && + (t.classList.remove(Z), + document.getElementById(ae)?.remove(), + t.close(), + it()); + }), + 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(), rt(); + } + function ve(t) { + if (!t.open) return; + document.getElementById(ae)?.classList.add(Z), t.classList.add(Z); + } + 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), + st({ trigger: t, searchEl: e, results: r, field: n, status: s }, o); + } + function st(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(() => { + ot(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 && !ct() && l.key === '/'; + (d || f) && (l.preventDefault(), a()); + }); + } + function ot(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 at = { + '&': '&', + '<': '<', + '>': '>', + "'": ''', + '"': '"', + }; + function te(t) { + return t.replace(/[&<>"'"]/g, (e) => at[e]); + } + function Pe(t, e) { + t.innerHTML = e ? `
                                                                                                                                                                                                                    ${e}
                                                                                                                                                                                                                    ` : ''; + } + var lt = [ + 'button', + 'checkbox', + 'file', + 'hidden', + 'image', + 'radio', + 'range', + 'reset', + 'submit', + ]; + function ct() { + let t = document.activeElement; + return t + ? t.isContentEditable || + t.tagName === 'TEXTAREA' || + t.tagName === 'SEARCH' + ? !0 + : t.tagName === 'INPUT' && !lt.includes(t.type) + : !1; + } + var D = 'mousedown', + Oe = 'mousemove', + $ = 'mouseup', + ne = { x: 0, y: 0 }, + Qe = !1, + ce = !1, + ut = !1, + F = !1, + Me = /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test( + navigator.userAgent + ); + document.documentElement.classList.add(Me ? 'is-mobile' : 'not-mobile'); + Me && + 'ontouchstart' in document.documentElement && + ((ut = !0), (D = 'touchstart'), (Oe = '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(Oe, (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 Fe() { + 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) Ne(n, t, []); + window.app.createComponents(t), + window.app.showPage(), + window.app.ensureActivePageVisible(); + } + function Ne(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) Ne(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(document.createElement('span')).textContent = t.text; + } else { + let r = e.appendChild(document.createElement('span')), + i = window.translations.folder.replaceAll('"', '"'); + (r.innerHTML = ``), + (r.appendChild(document.createElement('span')).textContent = t.text); + } + } + var oe = document.documentElement.dataset.base; + oe.endsWith('/') || (oe += '/'); + function Ve() { + document.querySelector('.tsd-full-hierarchy') + ? dt() + : document.querySelector('.tsd-hierarchy') && ht(); + } + function dt() { + 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 = mt(), + a = s.querySelector('ul'); + s.insertBefore(o, a), + (o.dataset.dropdown = String(!!a)), + a || s.appendChild(i.cloneNode(!0)); + } + } + } + function ht() { + 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'), + pt(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 pt(t, e, n) { + let r = e.roots.filter((i) => ft(e, i, n)); + for (let i of r) t.appendChild($e(e, i, n)); + } + function $e(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 = $e(t, a, n, r); + c && o.appendChild(c); + } + } + return r.delete(e), s; + } + function ft(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 mt() { + 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 + ); + } + Y(re, 'a[data-toggle]'); + Y(ie, '.tsd-accordion'); + Y(ee, '.tsd-filter-item input[type=checkbox]'); + var je = document.getElementById('tsd-theme'); + je && He(je); + var gt = new X(); + Object.defineProperty(window, 'app', { value: gt }); + _e(); + Fe(); + Ve(); + '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 c0b57f24..38db1e3b 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1,2 @@ -window.navigationData = "eJydl11P2zAUhv9LrqvxocFY79YKTUiwVk0ZF4iLQ3LSWDh2ZZ8Uumn/fXLUNh9Njl0uiZ/zvMY5dtznvxHhB0XjaLldo41G0Rooj8ZRodNSoj2rHn/JqZDRKHoTKo3Gl6MoyYVMDapo/HwQ/Cgpr+sTCdYe6t1YW3JxefNvdKidgMVbY7QZEhwAzjI1mKIiAdI+gIIVDuqOSc77aNHYIVU1yFU/4Su3NLthzuDGz6dauT/vFKHJIMHaJ/aPmqt9xHfe4dV1JyAmIJ+0Ynyi8wXatVa2ISNnaE5uj3Rc59+/XVxdNnxLlFggmW2/6zDc73lpmO51AtJlu9eeAAmt7nGDshajKgt7NsS1E254c0wGCFfbAPkeHfbHkIERvwW+u1dqtJRo5gYtKtoZthK7SUFFw5kpZlBKOu7Z3QDXrUtRoC5paDs3Rr09P1u7udrermwCvpbURvzBRyN9vg7HaacSwcRordCK0/Zwodo5GCiQWmfPgLlGWblBIHQHFjvjLsUpbz+SHNQKfwGJDcY6EcCuMsOHxISoA3Q/kXyr0EY4Wc+m5sTDOB+yEupJUH5bgGBXuJcMUs9mkyBxzYVpl/Mw7YEL0i4w0Rs026lO2bbgCoKC4oc4yF9zHq0uyXMWdSFO+FBKEhkkpM00BynRs00YnouZg7Xv2qQSrQ3qQ67glCDP8g/jISELBFmE6JsgL6Yk950tXYgTLjAzaPOlfkP2WOnheK1F2v9zvPcY5MUb/cY2YIvgVG6F7lSmOVmH4XS7i3b1jeeUPVyo1vPF7kc9X+z975TuDbgx5LtF92752WTonu7BP5nmNudEqFSo1YnBPZWfmsNyflJwjX8m7ZSo0BzX7F2fe+arq67Kc6M3Im0KslIlVXuftYC27fprQ1RarNA+x37sqPzlP/gAwEA=" \ No newline at end of file +window.navigationData = + 'eJydl11P2zAUhv9LrqvxocFY79YKTUiwVk0ZF4iLQ3LSWDh2ZZ8Uumn/fXLUNh9Njl0uiZ/zvMY5dtznvxHhB0XjaLldo41G0Rooj8ZRodNSoj2rHn/JqZDRKHoTKo3Gl6MoyYVMDapo/HwQ/Cgpr+sTCdYe6t1YW3JxefNvdKidgMVbY7QZEhwAzjI1mKIiAdI+gIIVDuqOSc77aNHYIVU1yFU/4Su3NLthzuDGz6dauT/vFKHJIMHaJ/aPmqt9xHfe4dV1JyAmIJ+0Ynyi8wXatVa2ISNnaE5uj3Rc59+/XVxdNnxLlFggmW2/6zDc73lpmO51AtJlu9eeAAmt7nGDshajKgt7NsS1E254c0wGCFfbAPkeHfbHkIERvwW+u1dqtJRo5gYtKtoZthK7SUFFw5kpZlBKOu7Z3QDXrUtRoC5paDs3Rr09P1u7udrermwCvpbURvzBRyN9vg7HaacSwcRordCK0/Zwodo5GCiQWmfPgLlGWblBIHQHFjvjLsUpbz+SHNQKfwGJDcY6EcCuMsOHxISoA3Q/kXyr0EY4Wc+m5sTDOB+yEupJUH5bgGBXuJcMUs9mkyBxzYVpl/Mw7YEL0i4w0Rs026lO2bbgCoKC4oc4yF9zHq0uyXMWdSFO+FBKEhkkpM00BynRs00YnouZg7Xv2qQSrQ3qQ67glCDP8g/jISELBFmE6JsgL6Yk950tXYgTLjAzaPOlfkP2WOnheK1F2v9zvPcY5MUb/cY2YIvgVG6F7lSmOVmH4XS7i3b1jeeUPVyo1vPF7kc9X+z975TuDbgx5LtF92752WTonu7BP5nmNudEqFSo1YnBPZWfmsNyflJwjX8m7ZSo0BzX7F2fe+arq67Kc6M3Im0KslIlVXuftYC27fprQ1RarNA+x37sqPzlP/gAwEA='; diff --git a/docs/assets/search.js b/docs/assets/search.js index 50b707be..89ce8680 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1,2 @@ -window.searchData = "eJy1XV2T47it/S/u174TA7K+5i27dXMrVdnsVGY2eZjaSqltdreytuWS5O6dbO1/v0V92CAJUpDsfZqpNglA5CEI4kDUb6u6em9WH7/+tvqlPO5WH/FxdSwOavVx9eXbSTWrx9W53q8+rg7V7rxXzZ+6v354bQ/71eNquy+aRjWrj6vV74+jBMDsIuPP5/b1ImJoPYjQPzFyHlenolbH9mIAEbzGzUXydl+qY/vX3ZT0h75huQur6Tr4dO2qQ1EeJzVdms3Qg+vNdbSKc/ta1eV/1U/1flLbpfG5nhjCoM5trYpW/dSoenoku6bnvulSferX7WtxfFGT2kjDW3X9vWjLN/W52pbF9LiOnY5dp2bstNSGffVSHv9Vtq//eyjKae1d8/eyfVVD85v1/vjjd3KtVfV0F51fPs3Q2Z7uofMfalu9qfrb99VuGlwX5fXQa9v3utmKzz98litvDs1tOqtzK3EVfcvb/MThvG/L52LbVvX3r8V+ryRrmHTakk5LbTgVTfNe1bu9ahr5kqK97rGybCskU27bcNvMj9L+oYr9Qay7Hlov1Vqr51o1r1+qX9T0Xjg0bofGy3U2qv00PIBAaaPa07X1cq1v1S/T6L40W6pHb6V/PT5Xk5p0w7JvOCeGIYHYd0Wj/reuK98uf/l9XkgWwzVe3FbHpq3PerGLlDyYHUIPdrXeE6G1306++bKUDi1nayNj+X2tdjqkLPbND8WxePGGTm7DeaNrBmp7VdRE4jydD133rdE9NAbMM3rselHtcqteVPtH2PRaNP8s9uVuuWGvRfOmJfwR1jXFm1pume59J6soqPUJwGdK99sN0H1RbeCAcZWu4SA4XvSmevfGdvsq09Y1XaCPDtu/1FPgjDv8esPQXU55Ag0PtHHogUajfZ6mOG7VXv5kD32Hd/VU9B1u0a3d1GfVNGXlCzJM1bp9c2k/U3OcGJmK9ffVsVW/tn89tqp+LrbXQS/Hv9C92Wl+QzrDnecZKsUTzz/klEluqL3Itjmx90IjQ+f95TYvSwgsewR6Wl9ssewUv9BAcrRfbqDoyL/MwE/s4WixqXNPT8uMZpMXi22emdRYZjI99i62VHYOFhvI71xzrJuzlc0zzRe+z7JuXhA/30B7551tnGwrnmWYMo6tcywae15NaZvd/5TN/5THV1WXrdrdaJrn7DPHxlknoFnGhQ5BcyycfxSaZWbZ/K0qduXxZZFxZbO/9P7DppnPQs0xc25maoZpOgf1Dy41N88+LWZm0k5sZKOOuy6AXLy9aQld7HjvLU0L/iGU2p5r5cKU9yyDP//w+aaRbA7NvcfxTE/cc+xxzt+3r137WPe5LdqJweqa3HB8E+xRVxXMvsQ/ZG/4bX6TqOV95QLV05NNtAr5YlshrvMUYjTP5/9Qzak6NtfJ1NlcA2Rjixvm8lUVO5oLC+t4uDafXEwX8z2a/9OQ0GtC7dD2Zp3VL1KNXcub9TVt0Z7Fg3tpfbNe7SykWoe2S3TasP2i9uqg2vobq/vy6y2u5/gmkP3QNws90tVUj6buH4Gqod1Nut5UbRxEAuquTedqvKYd/1Zti72eUx3gbou2rI5/U2/qmj1Sx/Oh+ZOvWbge6rob7dRbuSW5/zniH/rOW9qZf2Dvw7A2NW1dkU1EYsmlyz30v6vil1nahw6LdQdn/XNbF616+TZt0dhy3tz/+H4ke6dM+DDz1dBV/OCXZ5myR6dzvisrvTzKbXODdTql80QF3WLrdZ4+F89FXf6zVO866qur/V7Vn/SR6tgOnb/tlWW2qI907opzWx2KttwuVvJARfCjIntK1r7tudZChph4uZGDnO1Fzh9gadNWh1ssHPrf3bLnqj58flXqhuHTIppBxP3tO+/3n7e1Iif8+Qae9/tmlHF3C4/VcfkqfBh6390qnQn//k7rQ8v649eI1vKXO8y2lvPHzvipeFE3rhkt4g9bM6fqpAfhBusuAu5kGykd2Knn4ry/Dt3Icg9/D+5N0rorKktUbzUaFWCAwkqCvMmE9O10YZX5QNf2h0v7RZrfPcUOhropVsjV4VT7uRU2hoaxifgZCJy+lAdVnVtPkR/58S7AcgTKqvmojbNK+Rx1Th1fMG/I63XqP3486UXL0iT093DYGHxLJSRx+lUVw0jZyypBhRNvrEjU2dmyoL6pXJlE4d49PMyZtoeuf2H0ry79l5vVOomeoBW0+Q1Ke1wLVV4az1JoL5LxBaWJQbeayZdMrXZlrbbtT3U5R/bD2O/c9fM/om2/n/PrcntfqDuS2dF3DBYazzCk8bEXXgvGHktU09n+nlQEBGabaTbDQXbnuc/bV3VgH9InfDgINmNH/lm5J/BzGn9TL8X22/fFfv9UbH+hL9ZIDDo3at8J2A4CQu/bhA3zTcKnoi4OqvW4W76lfCqe1U7pJAy7WQWEP9CO049LHsK79NpzffxSCWbANqXv2lbSsWeNMYb/8npkaAXYjWbgvzoe1bb11Nzwgh+MTp6HdOz20Qe+wk6P7nAFp1jtc3Eo99/+bVAK08rNXjea8FK+qeNcC4xONxoQCJ082qfiJ7Hqg2qLXdEWM3STLjcqnznk9xnsY7n9Za7ia5cblZ8CtUMe5ZPFQnLlpQ6K5jz4tceNqvV5duagky7zlVPPzRWDB3x4oLncmxfnXamO/HsDUwoeSGf+yUNPNN/FTNoz5WwWmNNsKz6anjRm7Hk/U85P/1Hb1lsyN21RLyBcLHejYb7DxyzjggeRBQbqFfqprp7L/TLbdP/Tpf8tZnHLXbDEFwRpfLEdJ/AhWFlnW7nsDMzqlZx/herfVF0+l3yNF6ubdJirmM7h//XvCQam0Gwhn8GAH2RETro+y1BfhR6733P6Aik/ryo6cAyhHhhEf+s5O52/Vkau6sEUsx/EiKsGJiagf5njS9nynmrKuL57O3S/l1E71Wzr8uQ78k0ZZXa/n1FmYdJfhhzGMgvNOqXnq6x7maveiv25a/ip2pdbNuc6ZeZVxmmUcS/zxidejLxRwL2x15yf2qU2kb73MmexLXcwxHSf9I6moOdkGt7neOAXPX0w4O2fGcwEDAiGNLOUe7NNAe3hjNMs9YEwIGDAVDQwywTvEShgQPjwM6WeRfqPP34nwfm1mRzlT+VRv2Tge0PFJ/th6CcDG7H/hrm2TRDP9LT6w3PhPVt69R+ei/B5coYBVfU0ewqq6umG4eeB9uWTCGiXZnd2p5bgGc6UWH4LxCz9cohNqpdBzNI/A2KTBvSv8ct1h177D6tloUVfmpdgjGl/lxPkpAL5pHOPdMvsey2Sw2CGSfXELQbTZoluLhCaxmLm8w+fJVC5NruzO7IEz3BHxPKlkZ2tXDbK04ola8PWLV4S0+pPr9VR/f18eOIzVl4Tun7Hsd/NZkxHdrYBwriOVW2hu78JNAxto819athYqdN1bI7BS0oSeN3TxQhS5WMZglz3WH2wRDWdT+6F9MDUBpovSuhVNT/ZU3oeDBmB6Q89nw+EYzsfJTJp3EVCkA9ZYFrA+00aNeUFF5gTigsm7ZkMC2QGUTB/4i7tDaA51H4enLvinmU6Oiifxv78UAQfbG7+Y9qicBpkiTEB4E6bM4XcJQbpuymWWTP0vMmUEGjDYaO/9R8FWDeMnA3Xm8K6KXvmouPmIG/KIEmsN98oKWCdwG8OXCfDP+PGOwFMabv7HG+8kqfPN6zxywHpWiCFosSAUB2X34LJUq45JtS+aw39+sNXF85R7j3i+JWHzzhzlIeKyfz6J+vJJkwwF9pwt3BwkZlt7pJhYoUKkG2ZO6tOgdcZiOql6kK1p7zSydLTgGo6f/SatMAUMs3uMos+uZMTydntdQ/hm+C8NojufpthiNdVeC0Ie4qwanOWyW19wWl2292rcN8rW1K7zz7A3AOF34LwQWKO8iDWfeqnwR40wJxpfWthcIpJgzutYVui4IGolYvXraNXuGJ55XQYfxo+QxIYSKvJXYaSkzk5mLatvsoS3ziySsND6FdJB3G4dLh7sy4wkEyz+70s5xMue1mOewKf1zlpSXWxD9wX7DXm0nnqruAZBu2Vei/YMjCvGZcuNyuXvjroNWXWq4PzDPv8F+6KirnWNc9NJ+WtVO9bKmWJib5VE367kW854/i625XakmK/WM/DVcaJypgehOl3HkOn66BJU+freWaEo5qQIYK4Zp4p5fGt7C9RESwn25prZ+lSmjboUPz6Z/5i4JAlh+LXInAD8DwTjtUCiIyd7mFAVb8Ux/K/xRKEWH3vYc71PYnZCLm+LnEvfHhPPCEzwoeemQb4bgoIGhC8LGDSAPu+U+6y+f7uTvLLDK+93aqmMaNiXtxD3zQcylHrfKHNr6eyVs2f7ctiHX1Dw8J/oYZAW7kTPVu5u/m52AOGR53oZCHQaa4Ij7LwChBoaZ035Tyapt+G47XZGGc50B+/81xOPdE6uBaEmvv7O7vq2XlGMB1vt+fLpzlGXFvPOAexxQByJbfUApCnmzcuMwZl0VwY37zrZes/zYqQa9XYbvsi4+H6u/+c7K8Jr9vXHd2ebOm0xXz5ZhrMlh3OeE3K/Wf/duMuLP/t2mq+nv5ii78XzgXbVyV9kyCVEdLwor+g4QXIw+XnBZL1lRhB07sWiy3vLuzyC7/8PF/yodzt9ipoet9kse3HkOzlUu27LBzJUzdXhKRzTLutQEKnC3VMri6i66Y1Zt+D4eiZuPUiKLtWz6qu1e4nm6R0tIwtJ4nJsD7z/XtXS/j9+pDs5vzkldv/Nl/m+aRd+86Jqq+ShxaBcDok/109NWVgd7n+Pl/2f6ujKulXum3hpIFIenKV3d2596mu3krqnJ/Pxy6TMtziN/4u38pPdXXqPxohEanRcmqH5vwTmHayj3JuVNeKUTn+xD3Az4+r8rhTv64+/nb56MPHFX6IPuSrx9Vzqfa7ZvXx6+hJt9XhoE16XO2q7bn7789Ds38qHUTpxn3rP61Xj1/XjzF+gE3+88+PX8fO3Q/dH0YZ1790HWH1+BUeN+mH9QaMjuB0BKMjrh6/4uMm+pCkidERnY5odIxWj18jTmPkdIyMjpvV49cN94wbp+PG6BivHr/GXMfY6RgbHZPV49eE65g4HROjY7p6/JpyHVOnY2p0zFaPXzOuY+Z0zIyO+erxa851zJ2OuQkAjQdgsQMueMBCTwcfYDszADIRBBoXgGxnF0Rgogg0NiBiO7tAAhNJoPEBLJbABROYaAKNEWDxBC6gwEQUaJwAiylwQQUmqkBjBVhcgQssMJEFGi+QPW7gAySR2dkFF5joAo0ZyFk/4QIMTIShxgyyCEMXYWgiDDVmkEUYughDy0d1TopFGDJuykQYasxgxLo4F2FoIgw1ZnDDDRi6CEMTYagxgzHb2UUYmghDjRlM2M4uwtBEGGrMYMp2dhGGJsJQYwYztrOLMDQRhhozyHowdBGGJsIijZlozW4qLsIiE2GRxkzEIixyERaZCIs0ZiIWYZGLsMjaCbutkN8Lmc3QRFikMROxCItchEUmwiKNmYhFWOQiLDIRFmnMRCzCIhdhkYmwSGMmYn1Y5CIsMhEWZf5ndhEWmQiLNGYidnONXIRFJsI2HcJYeG5chG1MhG00ZjasA9y4CNuYCNtozGxYeG5chG1MhG00ZjYsPDcuwjZWvNUFXOwWu2FCLhNhG42ZDR+uuQjbmAjbJF54blyEbUyEbVKvA9y4CNuYCNtkXmxvXIRtTIRtNGY2vNkuwjYmwuK11/XGLsJiE2ExeF1v7CIsNhEWdwhjnzl2ERabCIsjb2QQuwiLTYTFHcJYZxC7CIutqL5DGLueYyawNxEWa8xs2PUcuwiLTYTFGjMxu55jF2GxibBYYyYGLqyIXYTFJsJijZmYXc+xi7DYRFiy9sIzcRGWmAhLwAuSxEVYYiIsQe8zJy7CEhNhicZMzLqhxEVYYiIs0ZiJN4+YfIjNri6+EhNfSXdsZOP8xMVXYp0cNWJi/uzIHB5NfCUdvthlkbj4Skx8JR2+2GWRuPhKTHwlHb7Y1Zy4+EpMfKUaMQm7LFIXX6mJr1QjJmEhkrr4Sk18pRoxCbssUhdfqYmvVCMmYfGVuvhKTXylGjMJu82lLsJSE2GpxkzCIix1EZaaCEu75ASLsNRFWGrlJzRmEj5DwaQoTISlGjMJi7DURVhqIizVmElYx5u6CEtNhGUaMymLsMxFWGYiLNOYSdlAKnMRlpkIyzRmUhZhmYuwzERYpjGTsgjLXIRlJsIyjZmURVjmIiwzEZZpzKQswjIXYZmJsExjJmURlrkIy0yEZV0KjEVY5iIss7JgGjMpnwdjEmEmwjKNmZRFWOYiLDMRlmvMZCzCchdhuYmwXGMmYxGWuwjLTYTl6E035C7CchNheeRL4+YuwHITYPnGm23IXYDlJsDy2HuEzV2A5SbA8sR7bM9dgOUmwHINmYxdkbkLsNwEWJ75B9sFWG6lWnNvbidnsq12urVDGJ+4XHMJVyvjugZf4r3/ye5u5VzX6Eu/9z/Z3a2s6zryxFP9L3ZvK+261uDJ2JHrf7P7W5nXdewNT/rf7P5W8nWtIZTxqds1k35dW/nXdYc5Pnu7ZjKwaysFu+7S++wZr//N7m9lYdcaSxnrF/vf7P4W9rrsfcaPH5fsd7L9Gkw5zxWw+X4LfF0OP+fpJi7lb+f8uzR+jnx/Bn922r/L5Of82uMS/3bmv0vm5zx+udy/nfzv8vk5jz8u/W/n/7uUfs7jj2MAbAqgy+rnKes8OBLAZgG6xH6ePUb5B4hTqz+DP4sIgC63n7NbMzBUAFhcAHTpfVjzAGToALD4AOhS/Kz7YvgAsAgB6HL8sObxy3ACYJEC0OX5+UMOMLQAWLwAdKl+WPMLgKEGwOIGoEv3w5r3/ww9ABY/AF3KH9b8EmAoArA4AujS/rBmww1gaAKweALoUv+w5hcBQxWAxRVA1BOe6WOUfthk1iwwdAFYfAF0FAALIoYvAIswgI4DgHX2GCUf1rEtgEGhRRpA1KOQX0UMbwAWcQAdFwAeypfhDsAiD6DjA8BD+zL8AVgEAnScAHioX4ZDAItEgI4XAGADOGB4BLCIBIgCOzFDJYDFJUBHD4CHQmboBLD4BOgoAvDQyAylABanABsvChlOASxSATqeAIDN5wHDK4BFLEDHFXhCOYZaAItbgE0PQp7MZugFsPgF2PQg5IMhhmIAi2OATQ9Cfh0xNANYPAN01AHwxDYwVANYXAN09AHw5DYwdANYfAN0FALwBDcwlANYnAN0NAIgHxExtANYvAN0VAIgvw4Y6gEs7gHivgjEU07BANHiH6AnIDzunKEgwOIgIN4EfAlDQ4DFQ0BHLXiiIoaJAIuKgI5dYFcyQ0WAxUVAnAb2E4aOAIuPgLhHIb+hMpQEWJwExD0K+aXM0BJg8RLQUQ3sADC8BFjEBCQ9BPnKFoabAIucgKSHIO8IGH4CLIICkr4WiXcEDEcBFkkBHfPgwzDDVIBFVUDPVbAjyADQ4iqgox+8I8iVJVkY7CgI4GsogKEswOIsoKMhgK+jAIa2AIu3gJ64YAeAAaBFXEC6DgwAw12ARV5Ax0dAxPtRhr8Ai8CAjpOAiPejDIcBFokBacgNMjwGWEQGpCE3yHAZYJEZkHoxyJAZYLEZ0BEUoDl/Tj2DQYvRgDTkBxlSAyxWA9Ieg7wfZIgNsJgN6MgKPjPHUBtgcRvQ0RWe5ALDboBFb0DWY5B3wwzDARbFAVmPQT6iYlgOsGgOyHo/yDtShukAi+qArK/LZDPCwLAdYNEdkHkxyNAdYPEdkIX8IEN5gMV5QEdjAF+sAwztARbvAR2VARv+gM9QH2BxH5AFMjQM+wEW/QG5dytm6A+w+A/oKA3Y8OkFhgIBiwOBjtYAvmwIGBoELB4EeiLEM4AMFwIWGQK5r2AAGDIELDYEOoLD58UYQgQsRgQ6ksM7ggwELVYE8h6CfDzNECNgMSOQZ4GNhCFHwGJHIPduxQw7AhY9guu1P0OFDD+CFj+C6x6DrBtHhiFBiyHBdSBBgwxHghZHguvIn+JChiZBiybBde8GWU+ODE+CFk+Ca58bRIYlQYslwXXizw0gQ5OgRZPgOvXnSZHhSdDiSXDdu0F2J0KGKEGLKMG1D4PI0CRo0STYvxLBbgPI0CRo0STYvxXhQRDDk6DFk2D/ZgRfnoYMUYIWUYI9UcIm+pEhStAiSrAnSthtBBmiBC2iBMELQIYmQYsmwf4lCb7ADhmeBC2eBDveg1fPoM9iSTDwpgQyLAlaLAn2L0vEnncWGPzZ70ugbxNG7n0J+4WJniThiwSRe2fCeWmiQx9fcYfsexMW+jrag6f5kHt1wn53oqM9IGajAORen7Dfn+h5Er52D7lXKOx3KDragycakXuLwn6NoqdJ+Po/5N6ksF+l6GkSvgYQubcp7NcpepqErwNE7o0KiybBEE2CDE2CFk2CHfHh8UEMUYIWUYI9URLzTpAhStAiSrAnSviCRGSIErSIEuyJkoRfyAxRghZRgj1RwhcmIkOUoEWUYE+U8MWJyBAlaBElGAVOxcgQJWgRJdgTJWzJADJECVpECfZECV8hiQxRghZRgj1RwldJIkOUoEWUYEd9AF8piQxXghZXgj1XwldLIsOVoMWVYMd9eDYUhitBiyvBnivxTCLDlaDFlWDPlfAlm8hwJWhxJdhzJXzZJjJcCVpcCfZcCV+6iQxXghZXgj1XwpdvIsOVoMWVYM+V8LkFZLgStLgS7LkSvgYUGa4ELa4EO+qDr4JHhipBiyrBnirh60iRoUrQokqwp0r4WlJkqBK0qBKMA2Ehw5SgxZRgx3wAX4+KDFWCFlWCHfkBfE0qMmwJWmwJ9mwJX5eKDFuCFluCPVvC16Yiw5agxZZgz5bw9anIsCVosSWY9KcTfikxhAlahAkm/lJ7ZPgStPgS7PkSvgoFGb4ELb4EB76EzZIgw5egxZdgz5fwlbbI8CVo8SWYxP4yFmQoE7QoE+wpE778FBnKBC3KBHvKhK8DRYYyQYsywZ4yyfjFzFAmaFEm2JEgwFdDIsOaoMWaYM+a8OWQyLAmaLEm2LMmGb8YGdYELdYEe9aEL4hEhjVBizXBnjXJ+MXIsCZosSbYsyZ8SSQyrMn4t+4qkDdVt2r31/5KkK9fV8a1jr+t/j1cFqKDn06dvjdEhzcff/v99+v1IB9/+53cEKJ/0xr5+3uJ0DgjQjGXCu2vRSNy0ojIiVEm53KTLxG0Tq+CdM1V11Wz9f1/ks3wn3T8S571/8FIOCTn9tXQSPT1XfJILGit74ZWv7aXq0ep5Ig8SpTKZVbjZepXURkZXl0LLpZ1uty0Q544o5OeSierfV3Xlxv9rtJiYloiH7nhq4llddyrN7U37AOKgc1mrsz+S4xEXpQTeZncxu4SWGNGN2RGByRG2Tx53fW7V5FEovxBR0EcUhKKFDnqOpHvZfs6XB1IHpqgJRJ6CEPgr9vX4viijkVbvqmm2paFKZ/MjtStUflV9WQM6JqIgwXi9Ce7iTjiHzbypXIRN34Ka/gkFRGMRPBMTGrB5oejiVyyHmesnYvc5mDgaUMBGovFjZ/mI6uQPrBmLAf3LX/04eJm4nqIxFiMzOpQtOWWyknJHGcyyDwVjVJ1XRmOFZFupjI5/V209iTqOqrrYAmfjVwoSnfmDd2ZZaO9LY5btW/Ldm/Kgow6Zhkaelnv6sneeCMSz0Rx33uTyGSat9lSkK0pyAYXrQ/xIrF7VdRbep83mVviVzEZrJW5107s5dMfZACIyGgUKdtNqEhmE8jpKIAM0VQkHyzmNAgBmWu5fhibDCUZycELrGEM64QzZa8XoLb1wZYOGy/RotBa8kkH8tx0LcIYbkI0xp3C8a2OTVuf9Y19xmDQwHkQmQ/DkgvBUKuiVefGjPLI6hIu1IsYDlE0rAAh7vmVBAn1SMKIgsg6FMfixXxWpEejwZXkwik/1/rGxyGON3YFgtNM5s37rw4ZQsj0CiNP89NFZAroSQUGiCDKhO7Uc3HeG8+XEXm5DMM71Wzr8mQvEF0+T/YFmQ/fqbdyq67zSgVShAiXri3uefiwkLmrUr8o9N694Or9aEIuIVthKlunRJIOtJ7K6qDautwaqyMhQyl0hrvqUJTmzkI2ltHDyhDsRP853fIhHx3rsMh05djgDse9NpbNl3WDOA1YjMUs813q+GYMIpnnVHakcL/RRbMk1GOh8AHt6HBDnmszDFsiNO6t2J+7w/Kp2pfbbyaoqV8Qxg/jmcwYNHKOnyXEd7Aj26ZsqXECmb1Iv/Z3fWJh0mqUzckDejKJpA9/+RgK3dpolCg8fY6eyg236XkChDFsf2n+v7tudBlTD40y1NH79+n6pM8Yy0brWe1UrW+7NmzaUNdy8ShC46r60LwqZW7ZRGImW6bP5/2+2dbKTLZSH5TJXND4PQE6UikdKdkaeFGt7wRCpQ0RbiwbrBfV2uFhRLyGMIIdpLArKKZIFRqlv5HgAFW/102QKrTs+rkFOvw0zRnLHONr0bwV+3LnmwMqcjgJxDIbL9/5JCE6geslsb0ed2wcD0fReDjajP+Jh9MiJGOCPBmXTzJu0ellQY3/ycfG+agrH3fvdTz+57Kfj3+BdIw0ZdNq5V6B+urNGLWuZW7j8hUo6mLpMhBm5KyP49GdnfhFXTokktbsq0JnbYzdnTxnPDxmIkPGfxoz3IjJYkpkzmf8tCd9MhpGoVCM/rLIRHY+IcFlKjt8MGK5zDXdDtYjRIWpUUZF0+od58UYFQqeVOaQx6+tUMdCQSNMzu2rl/LI5teJS5H5KFMU547peRiEbNxFqpVPJ88680mr6ok1jnoEoVu+yjSz80A3C5l/oqI48yIqUkhoXWT6kvJgnN2Xy2QNplFiMnM8rWy/EQnPxE1zaFjz6LIWko376qU6t7avNlJ88+SwhlEcCo/w47dN6X60pjuIzK6Daotd0RYmlClGxlQgCim8w3PhbpU0WoFkDB6SMXhIx3ggk+3G9MtQlE2mAyA80B6u34C75PLNPD6NGhaLrKonjrIGmmRBYb7KI7/P5HQkDqsqpaMjTDmxqjgE0/kVpihZ2e2Jtx2o7cIVwsjnhVMaQHiOsbGXEAPTEd84ZqKE4df102F0MRqOcIyFE9kYD98fpoCjIxnJAH2sjoYQeu4WrtjKSH/GNMMjFFA9udQkTSUIR8T8EjIdGIqCSBal2jEAPcrqOwVEMt5UHUj9kzAxkwv05BJogCdbRKfiRbnJDTLumSwUG4sPTGjTfXSkMlFYVDRK3KumYaNZIxMgm09WJufvaC0GCOfFFm4HPDQIkK0JRiJrLN3Cctky8RaLGBVR8x68k8UaSGcqlwptt69OKomsYeER+iKHNYye8NcyZ2l8npH6BvqQ6Rj55BeHLovX2A8y0hCIuvdEaPH48UW6NClmxhwfCnMAp+qknZBxtCTBRy5c4O7XGumDUnct3EMuX2akcijrLXTZ5Jt9VBIN5YT5CHd50ewNrmVxg/esF1EHm0qF7cpaaUSUxgTSdb8ea6aEJYdXmaaHToySA9kkmh9Ip+NPXfIAWFiP/xn/IsziUC2sZ6Dp17V0FBrVshshjWOGtKewPsqQyRpKUSk8SI9Rsl3TRKt1YS3b+GvVnutjW5m4pGAS1rmNgiwM5dStCvfNWr1VvxhPRul4YXa5F8INeUyFzTLJh226DwlZ7aZ4LuryrVTvOqqsq/1e1fpspY7tkJP8ZnpCejwUMl9N8aZ89ASFnQwpzbaySujWFG/RSELEY01VOm5L6zGZD8PJC8e6KxTWnTbqaK5IWrsK+Xigy2WTqaV1oaNTEUseSFhPoGVN5SjoGhfSoFpsc2hsAyl0hTShUwtL90G4OGDhTqGlnU1qimBfuD83bV2ZnAh9YyUVDvz5ydxeaOWFMLnZnJ/+o7atu1et6RgJU3VUmFNtaqSfhcf65vzEMP0U+MJkSKv2ShcQGQQH5bMuVOBaNvb2KZi+GyQc+rY8qOpslpnRrULI+w1inBIaGn4KTyzMWNMgW0jeuliKjVrvGVIcENFKMhQWVdtC6DON+a9ctgE4ITXBtAyI5EPmdOVS/jGR2XJuVNF/UZuGaXRjF1YDnhu1Vy/F9tt2KK6x4xea3rtU8qIMnU6lLTn9xUPEm4yboxBgWmb/RXUyqfRUOU8MGyAZ4sQT4h4C13RFj1UQuJb5Uy2ROxEaDJkwEahlGc9Iubvx3UFh9HBuVPPMhW/mGNJzIso80JAxMAUZBIewBnr8WDzdYQmOhdzauyqMrDAtWUtlY8W9zEFLTscydtksDtK6F5BY3NLjqvC1GirT9+YrzTKhbHt7V09Nab1fQ1+4Q2Gx6X+ro7JXO2RGfZdgvf/8uDqVJ7Uvj2r18evPv//+/6VzCuo="; \ No newline at end of file +window.searchData = + 'eJy1XV2T47it/S/u174TA7K+5i27dXMrVdnsVGY2eZjaSqltdreytuWS5O6dbO1/v0V92CAJUpDsfZqpNglA5CEI4kDUb6u6em9WH7/+tvqlPO5WH/FxdSwOavVx9eXbSTWrx9W53q8+rg7V7rxXzZ+6v354bQ/71eNquy+aRjWrj6vV74+jBMDsIuPP5/b1ImJoPYjQPzFyHlenolbH9mIAEbzGzUXydl+qY/vX3ZT0h75huQur6Tr4dO2qQ1EeJzVdms3Qg+vNdbSKc/ta1eV/1U/1flLbpfG5nhjCoM5trYpW/dSoenoku6bnvulSferX7WtxfFGT2kjDW3X9vWjLN/W52pbF9LiOnY5dp2bstNSGffVSHv9Vtq//eyjKae1d8/eyfVVD85v1/vjjd3KtVfV0F51fPs3Q2Z7uofMfalu9qfrb99VuGlwX5fXQa9v3utmKzz98litvDs1tOqtzK3EVfcvb/MThvG/L52LbVvX3r8V+ryRrmHTakk5LbTgVTfNe1bu9ahr5kqK97rGybCskU27bcNvMj9L+oYr9Qay7Hlov1Vqr51o1r1+qX9T0Xjg0bofGy3U2qv00PIBAaaPa07X1cq1v1S/T6L40W6pHb6V/PT5Xk5p0w7JvOCeGIYHYd0Wj/reuK98uf/l9XkgWwzVe3FbHpq3PerGLlDyYHUIPdrXeE6G1306++bKUDi1nayNj+X2tdjqkLPbND8WxePGGTm7DeaNrBmp7VdRE4jydD133rdE9NAbMM3rselHtcqteVPtH2PRaNP8s9uVuuWGvRfOmJfwR1jXFm1pume59J6soqPUJwGdK99sN0H1RbeCAcZWu4SA4XvSmevfGdvsq09Y1XaCPDtu/1FPgjDv8esPQXU55Ag0PtHHogUajfZ6mOG7VXv5kD32Hd/VU9B1u0a3d1GfVNGXlCzJM1bp9c2k/U3OcGJmK9ffVsVW/tn89tqp+LrbXQS/Hv9C92Wl+QzrDnecZKsUTzz/klEluqL3Itjmx90IjQ+f95TYvSwgsewR6Wl9ssewUv9BAcrRfbqDoyL/MwE/s4WixqXNPT8uMZpMXi22emdRYZjI99i62VHYOFhvI71xzrJuzlc0zzRe+z7JuXhA/30B7551tnGwrnmWYMo6tcywae15NaZvd/5TN/5THV1WXrdrdaJrn7DPHxlknoFnGhQ5BcyycfxSaZWbZ/K0qduXxZZFxZbO/9P7DppnPQs0xc25maoZpOgf1Dy41N88+LWZm0k5sZKOOuy6AXLy9aQld7HjvLU0L/iGU2p5r5cKU9yyDP//w+aaRbA7NvcfxTE/cc+xxzt+3r137WPe5LdqJweqa3HB8E+xRVxXMvsQ/ZG/4bX6TqOV95QLV05NNtAr5YlshrvMUYjTP5/9Qzak6NtfJ1NlcA2Rjixvm8lUVO5oLC+t4uDafXEwX8z2a/9OQ0GtC7dD2Zp3VL1KNXcub9TVt0Z7Fg3tpfbNe7SykWoe2S3TasP2i9uqg2vobq/vy6y2u5/gmkP3QNws90tVUj6buH4Gqod1Nut5UbRxEAuquTedqvKYd/1Zti72eUx3gbou2rI5/U2/qmj1Sx/Oh+ZOvWbge6rob7dRbuSW5/zniH/rOW9qZf2Dvw7A2NW1dkU1EYsmlyz30v6vil1nahw6LdQdn/XNbF616+TZt0dhy3tz/+H4ke6dM+DDz1dBV/OCXZ5myR6dzvisrvTzKbXODdTql80QF3WLrdZ4+F89FXf6zVO866qur/V7Vn/SR6tgOnb/tlWW2qI907opzWx2KttwuVvJARfCjIntK1r7tudZChph4uZGDnO1Fzh9gadNWh1ssHPrf3bLnqj58flXqhuHTIppBxP3tO+/3n7e1Iif8+Qae9/tmlHF3C4/VcfkqfBh6390qnQn//k7rQ8v649eI1vKXO8y2lvPHzvipeFE3rhkt4g9bM6fqpAfhBusuAu5kGykd2Knn4ry/Dt3Icg9/D+5N0rorKktUbzUaFWCAwkqCvMmE9O10YZX5QNf2h0v7RZrfPcUOhropVsjV4VT7uRU2hoaxifgZCJy+lAdVnVtPkR/58S7AcgTKqvmojbNK+Rx1Th1fMG/I63XqP3486UXL0iT093DYGHxLJSRx+lUVw0jZyypBhRNvrEjU2dmyoL6pXJlE4d49PMyZtoeuf2H0ry79l5vVOomeoBW0+Q1Ke1wLVV4az1JoL5LxBaWJQbeayZdMrXZlrbbtT3U5R/bD2O/c9fM/om2/n/PrcntfqDuS2dF3DBYazzCk8bEXXgvGHktU09n+nlQEBGabaTbDQXbnuc/bV3VgH9InfDgINmNH/lm5J/BzGn9TL8X22/fFfv9UbH+hL9ZIDDo3at8J2A4CQu/bhA3zTcKnoi4OqvW4W76lfCqe1U7pJAy7WQWEP9CO049LHsK79NpzffxSCWbANqXv2lbSsWeNMYb/8npkaAXYjWbgvzoe1bb11Nzwgh+MTp6HdOz20Qe+wk6P7nAFp1jtc3Eo99/+bVAK08rNXjea8FK+qeNcC4xONxoQCJ082qfiJ7Hqg2qLXdEWM3STLjcqnznk9xnsY7n9Za7ia5cblZ8CtUMe5ZPFQnLlpQ6K5jz4tceNqvV5duagky7zlVPPzRWDB3x4oLncmxfnXamO/HsDUwoeSGf+yUNPNN/FTNoz5WwWmNNsKz6anjRm7Hk/U85P/1Hb1lsyN21RLyBcLHejYb7DxyzjggeRBQbqFfqprp7L/TLbdP/Tpf8tZnHLXbDEFwRpfLEdJ/AhWFlnW7nsDMzqlZx/herfVF0+l3yNF6ubdJirmM7h//XvCQam0Gwhn8GAH2RETro+y1BfhR6733P6Aik/ryo6cAyhHhhEf+s5O52/Vkau6sEUsx/EiKsGJiagf5njS9nynmrKuL57O3S/l1E71Wzr8uQ78k0ZZXa/n1FmYdJfhhzGMgvNOqXnq6x7maveiv25a/ip2pdbNuc6ZeZVxmmUcS/zxidejLxRwL2x15yf2qU2kb73MmexLXcwxHSf9I6moOdkGt7neOAXPX0w4O2fGcwEDAiGNLOUe7NNAe3hjNMs9YEwIGDAVDQwywTvEShgQPjwM6WeRfqPP34nwfm1mRzlT+VRv2Tge0PFJ/th6CcDG7H/hrm2TRDP9LT6w3PhPVt69R+ei/B5coYBVfU0ewqq6umG4eeB9uWTCGiXZnd2p5bgGc6UWH4LxCz9cohNqpdBzNI/A2KTBvSv8ct1h177D6tloUVfmpdgjGl/lxPkpAL5pHOPdMvsey2Sw2CGSfXELQbTZoluLhCaxmLm8w+fJVC5NruzO7IEz3BHxPKlkZ2tXDbK04ola8PWLV4S0+pPr9VR/f18eOIzVl4Tun7Hsd/NZkxHdrYBwriOVW2hu78JNAxto819athYqdN1bI7BS0oSeN3TxQhS5WMZglz3WH2wRDWdT+6F9MDUBpovSuhVNT/ZU3oeDBmB6Q89nw+EYzsfJTJp3EVCkA9ZYFrA+00aNeUFF5gTigsm7ZkMC2QGUTB/4i7tDaA51H4enLvinmU6Oiifxv78UAQfbG7+Y9qicBpkiTEB4E6bM4XcJQbpuymWWTP0vMmUEGjDYaO/9R8FWDeMnA3Xm8K6KXvmouPmIG/KIEmsN98oKWCdwG8OXCfDP+PGOwFMabv7HG+8kqfPN6zxywHpWiCFosSAUB2X34LJUq45JtS+aw39+sNXF85R7j3i+JWHzzhzlIeKyfz6J+vJJkwwF9pwt3BwkZlt7pJhYoUKkG2ZO6tOgdcZiOql6kK1p7zSydLTgGo6f/SatMAUMs3uMos+uZMTydntdQ/hm+C8NojufpthiNdVeC0Ie4qwanOWyW19wWl2292rcN8rW1K7zz7A3AOF34LwQWKO8iDWfeqnwR40wJxpfWthcIpJgzutYVui4IGolYvXraNXuGJ55XQYfxo+QxIYSKvJXYaSkzk5mLatvsoS3ziySsND6FdJB3G4dLh7sy4wkEyz+70s5xMue1mOewKf1zlpSXWxD9wX7DXm0nnqruAZBu2Vei/YMjCvGZcuNyuXvjroNWXWq4PzDPv8F+6KirnWNc9NJ+WtVO9bKmWJib5VE367kW854/i625XakmK/WM/DVcaJypgehOl3HkOn66BJU+freWaEo5qQIYK4Zp4p5fGt7C9RESwn25prZ+lSmjboUPz6Z/5i4JAlh+LXInAD8DwTjtUCiIyd7mFAVb8Ux/K/xRKEWH3vYc71PYnZCLm+LnEvfHhPPCEzwoeemQb4bgoIGhC8LGDSAPu+U+6y+f7uTvLLDK+93aqmMaNiXtxD3zQcylHrfKHNr6eyVs2f7ctiHX1Dw8J/oYZAW7kTPVu5u/m52AOGR53oZCHQaa4Ij7LwChBoaZ035Tyapt+G47XZGGc50B+/81xOPdE6uBaEmvv7O7vq2XlGMB1vt+fLpzlGXFvPOAexxQByJbfUApCnmzcuMwZl0VwY37zrZes/zYqQa9XYbvsi4+H6u/+c7K8Jr9vXHd2ebOm0xXz5ZhrMlh3OeE3K/Wf/duMuLP/t2mq+nv5ii78XzgXbVyV9kyCVEdLwor+g4QXIw+XnBZL1lRhB07sWiy3vLuzyC7/8PF/yodzt9ipoet9kse3HkOzlUu27LBzJUzdXhKRzTLutQEKnC3VMri6i66Y1Zt+D4eiZuPUiKLtWz6qu1e4nm6R0tIwtJ4nJsD7z/XtXS/j9+pDs5vzkldv/Nl/m+aRd+86Jqq+ShxaBcDok/109NWVgd7n+Pl/2f6ujKulXum3hpIFIenKV3d2596mu3krqnJ/Pxy6TMtziN/4u38pPdXXqPxohEanRcmqH5vwTmHayj3JuVNeKUTn+xD3Az4+r8rhTv64+/nb56MPHFX6IPuSrx9Vzqfa7ZvXx6+hJt9XhoE16XO2q7bn7789Ds38qHUTpxn3rP61Xj1/XjzF+gE3+88+PX8fO3Q/dH0YZ1790HWH1+BUeN+mH9QaMjuB0BKMjrh6/4uMm+pCkidERnY5odIxWj18jTmPkdIyMjpvV49cN94wbp+PG6BivHr/GXMfY6RgbHZPV49eE65g4HROjY7p6/JpyHVOnY2p0zFaPXzOuY+Z0zIyO+erxa851zJ2OuQkAjQdgsQMueMBCTwcfYDszADIRBBoXgGxnF0Rgogg0NiBiO7tAAhNJoPEBLJbABROYaAKNEWDxBC6gwEQUaJwAiylwQQUmqkBjBVhcgQssMJEFGi+QPW7gAySR2dkFF5joAo0ZyFk/4QIMTIShxgyyCEMXYWgiDDVmkEUYughDy0d1TopFGDJuykQYasxgxLo4F2FoIgw1ZnDDDRi6CEMTYagxgzHb2UUYmghDjRlM2M4uwtBEGGrMYMp2dhGGJsJQYwYztrOLMDQRhhozyHowdBGGJsIijZlozW4qLsIiE2GRxkzEIixyERaZCIs0ZiIWYZGLsMjaCbutkN8Lmc3QRFikMROxCItchEUmwiKNmYhFWOQiLDIRFmnMRCzCIhdhkYmwSGMmYn1Y5CIsMhEWZf5ndhEWmQiLNGYidnONXIRFJsI2HcJYeG5chG1MhG00ZjasA9y4CNuYCNtozGxYeG5chG1MhG00ZjYsPDcuwjZWvNUFXOwWu2FCLhNhG42ZDR+uuQjbmAjbJF54blyEbUyEbVKvA9y4CNuYCNtkXmxvXIRtTIRtNGY2vNkuwjYmwuK11/XGLsJiE2ExeF1v7CIsNhEWdwhjnzl2ERabCIsjb2QQuwiLTYTFHcJYZxC7CIutqL5DGLueYyawNxEWa8xs2PUcuwiLTYTFGjMxu55jF2GxibBYYyYGLqyIXYTFJsJijZmYXc+xi7DYRFiy9sIzcRGWmAhLwAuSxEVYYiIsQe8zJy7CEhNhicZMzLqhxEVYYiIs0ZiJN4+YfIjNri6+EhNfSXdsZOP8xMVXYp0cNWJi/uzIHB5NfCUdvthlkbj4Skx8JR2+2GWRuPhKTHwlHb7Y1Zy4+EpMfKUaMQm7LFIXX6mJr1QjJmEhkrr4Sk18pRoxCbssUhdfqYmvVCMmYfGVuvhKTXylGjMJu82lLsJSE2GpxkzCIix1EZaaCEu75ASLsNRFWGrlJzRmEj5DwaQoTISlGjMJi7DURVhqIizVmElYx5u6CEtNhGUaMymLsMxFWGYiLNOYSdlAKnMRlpkIyzRmUhZhmYuwzERYpjGTsgjLXIRlJsIyjZmURVjmIiwzEZZpzKQswjIXYZmJsExjJmURlrkIy0yEZV0KjEVY5iIss7JgGjMpnwdjEmEmwjKNmZRFWOYiLDMRlmvMZCzCchdhuYmwXGMmYxGWuwjLTYTl6E035C7CchNheeRL4+YuwHITYPnGm23IXYDlJsDy2HuEzV2A5SbA8sR7bM9dgOUmwHINmYxdkbkLsNwEWJ75B9sFWG6lWnNvbidnsq12urVDGJ+4XHMJVyvjugZf4r3/ye5u5VzX6Eu/9z/Z3a2s6zryxFP9L3ZvK+261uDJ2JHrf7P7W5nXdewNT/rf7P5W8nWtIZTxqds1k35dW/nXdYc5Pnu7ZjKwaysFu+7S++wZr//N7m9lYdcaSxnrF/vf7P4W9rrsfcaPH5fsd7L9Gkw5zxWw+X4LfF0OP+fpJi7lb+f8uzR+jnx/Bn922r/L5Of82uMS/3bmv0vm5zx+udy/nfzv8vk5jz8u/W/n/7uUfs7jj2MAbAqgy+rnKes8OBLAZgG6xH6ePUb5B4hTqz+DP4sIgC63n7NbMzBUAFhcAHTpfVjzAGToALD4AOhS/Kz7YvgAsAgB6HL8sObxy3ACYJEC0OX5+UMOMLQAWLwAdKl+WPMLgKEGwOIGoEv3w5r3/ww9ABY/AF3KH9b8EmAoArA4AujS/rBmww1gaAKweALoUv+w5hcBQxWAxRVA1BOe6WOUfthk1iwwdAFYfAF0FAALIoYvAIswgI4DgHX2GCUf1rEtgEGhRRpA1KOQX0UMbwAWcQAdFwAeypfhDsAiD6DjA8BD+zL8AVgEAnScAHioX4ZDAItEgI4XAGADOGB4BLCIBIgCOzFDJYDFJUBHD4CHQmboBLD4BOgoAvDQyAylABanABsvChlOASxSATqeAIDN5wHDK4BFLEDHFXhCOYZaAItbgE0PQp7MZugFsPgF2PQg5IMhhmIAi2OATQ9Cfh0xNANYPAN01AHwxDYwVANYXAN09AHw5DYwdANYfAN0FALwBDcwlANYnAN0NAIgHxExtANYvAN0VAIgvw4Y6gEs7gHivgjEU07BANHiH6AnIDzunKEgwOIgIN4EfAlDQ4DFQ0BHLXiiIoaJAIuKgI5dYFcyQ0WAxUVAnAb2E4aOAIuPgLhHIb+hMpQEWJwExD0K+aXM0BJg8RLQUQ3sADC8BFjEBCQ9BPnKFoabAIucgKSHIO8IGH4CLIICkr4WiXcEDEcBFkkBHfPgwzDDVIBFVUDPVbAjyADQ4iqgox+8I8iVJVkY7CgI4GsogKEswOIsoKMhgK+jAIa2AIu3gJ64YAeAAaBFXEC6DgwAw12ARV5Ax0dAxPtRhr8Ai8CAjpOAiPejDIcBFokBacgNMjwGWEQGpCE3yHAZYJEZkHoxyJAZYLEZ0BEUoDl/Tj2DQYvRgDTkBxlSAyxWA9Ieg7wfZIgNsJgN6MgKPjPHUBtgcRvQ0RWe5ALDboBFb0DWY5B3wwzDARbFAVmPQT6iYlgOsGgOyHo/yDtShukAi+qArK/LZDPCwLAdYNEdkHkxyNAdYPEdkIX8IEN5gMV5QEdjAF+sAwztARbvAR2VARv+gM9QH2BxH5AFMjQM+wEW/QG5dytm6A+w+A/oKA3Y8OkFhgIBiwOBjtYAvmwIGBoELB4EeiLEM4AMFwIWGQK5r2AAGDIELDYEOoLD58UYQgQsRgQ6ksM7ggwELVYE8h6CfDzNECNgMSOQZ4GNhCFHwGJHIPduxQw7AhY9guu1P0OFDD+CFj+C6x6DrBtHhiFBiyHBdSBBgwxHghZHguvIn+JChiZBiybBde8GWU+ODE+CFk+Ca58bRIYlQYslwXXizw0gQ5OgRZPgOvXnSZHhSdDiSXDdu0F2J0KGKEGLKMG1D4PI0CRo0STYvxLBbgPI0CRo0STYvxXhQRDDk6DFk2D/ZgRfnoYMUYIWUYI9UcIm+pEhStAiSrAnSthtBBmiBC2iBMELQIYmQYsmwf4lCb7ADhmeBC2eBDveg1fPoM9iSTDwpgQyLAlaLAn2L0vEnncWGPzZ70ugbxNG7n0J+4WJniThiwSRe2fCeWmiQx9fcYfsexMW+jrag6f5kHt1wn53oqM9IGajAORen7Dfn+h5Er52D7lXKOx3KDragycakXuLwn6NoqdJ+Po/5N6ksF+l6GkSvgYQubcp7NcpepqErwNE7o0KiybBEE2CDE2CFk2CHfHh8UEMUYIWUYI9URLzTpAhStAiSrAnSviCRGSIErSIEuyJkoRfyAxRghZRgj1RwhcmIkOUoEWUYE+U8MWJyBAlaBElGAVOxcgQJWgRJdgTJWzJADJECVpECfZECV8hiQxRghZRgj1RwldJIkOUoEWUYEd9AF8piQxXghZXgj1XwldLIsOVoMWVYMd9eDYUhitBiyvBnivxTCLDlaDFlWDPlfAlm8hwJWhxJdhzJXzZJjJcCVpcCfZcCV+6iQxXghZXgj1XwpdvIsOVoMWVYM+V8LkFZLgStLgS7LkSvgYUGa4ELa4EO+qDr4JHhipBiyrBnirh60iRoUrQokqwp0r4WlJkqBK0qBKMA2Ehw5SgxZRgx3wAX4+KDFWCFlWCHfkBfE0qMmwJWmwJ9mwJX5eKDFuCFluCPVvC16Yiw5agxZZgz5bw9anIsCVosSWY9KcTfikxhAlahAkm/lJ7ZPgStPgS7PkSvgoFGb4ELb4EB76EzZIgw5egxZdgz5fwlbbI8CVo8SWYxP4yFmQoE7QoE+wpE778FBnKBC3KBHvKhK8DRYYyQYsywZ4yyfjFzFAmaFEm2JEgwFdDIsOaoMWaYM+a8OWQyLAmaLEm2LMmGb8YGdYELdYEe9aEL4hEhjVBizXBnjXJ+MXIsCZosSbYsyZ8SSQyrMn4t+4qkDdVt2r31/5KkK9fV8a1jr+t/j1cFqKDn06dvjdEhzcff/v99+v1IB9/+53cEKJ/0xr5+3uJ0DgjQjGXCu2vRSNy0ojIiVEm53KTLxG0Tq+CdM1V11Wz9f1/ks3wn3T8S571/8FIOCTn9tXQSPT1XfJILGit74ZWv7aXq0ep5Ig8SpTKZVbjZepXURkZXl0LLpZ1uty0Q544o5OeSierfV3Xlxv9rtJiYloiH7nhq4llddyrN7U37AOKgc1mrsz+S4xEXpQTeZncxu4SWGNGN2RGByRG2Tx53fW7V5FEovxBR0EcUhKKFDnqOpHvZfs6XB1IHpqgJRJ6CEPgr9vX4viijkVbvqmm2paFKZ/MjtStUflV9WQM6JqIgwXi9Ce7iTjiHzbypXIRN34Ka/gkFRGMRPBMTGrB5oejiVyyHmesnYvc5mDgaUMBGovFjZ/mI6uQPrBmLAf3LX/04eJm4nqIxFiMzOpQtOWWyknJHGcyyDwVjVJ1XRmOFZFupjI5/V209iTqOqrrYAmfjVwoSnfmDd2ZZaO9LY5btW/Ldm/Kgow6Zhkaelnv6sneeCMSz0Rx33uTyGSat9lSkK0pyAYXrQ/xIrF7VdRbep83mVviVzEZrJW5107s5dMfZACIyGgUKdtNqEhmE8jpKIAM0VQkHyzmNAgBmWu5fhibDCUZycELrGEM64QzZa8XoLb1wZYOGy/RotBa8kkH8tx0LcIYbkI0xp3C8a2OTVuf9Y19xmDQwHkQmQ/DkgvBUKuiVefGjPLI6hIu1IsYDlE0rAAh7vmVBAn1SMKIgsg6FMfixXxWpEejwZXkwik/1/rGxyGON3YFgtNM5s37rw4ZQsj0CiNP89NFZAroSQUGiCDKhO7Uc3HeG8+XEXm5DMM71Wzr8mQvEF0+T/YFmQ/fqbdyq67zSgVShAiXri3uefiwkLmrUr8o9N694Or9aEIuIVthKlunRJIOtJ7K6qDautwaqyMhQyl0hrvqUJTmzkI2ltHDyhDsRP853fIhHx3rsMh05djgDse9NpbNl3WDOA1YjMUs813q+GYMIpnnVHakcL/RRbMk1GOh8AHt6HBDnmszDFsiNO6t2J+7w/Kp2pfbbyaoqV8Qxg/jmcwYNHKOnyXEd7Aj26ZsqXECmb1Iv/Z3fWJh0mqUzckDejKJpA9/+RgK3dpolCg8fY6eyg236XkChDFsf2n+v7tudBlTD40y1NH79+n6pM8Yy0brWe1UrW+7NmzaUNdy8ShC46r60LwqZW7ZRGImW6bP5/2+2dbKTLZSH5TJXND4PQE6UikdKdkaeFGt7wRCpQ0RbiwbrBfV2uFhRLyGMIIdpLArKKZIFRqlv5HgAFW/102QKrTs+rkFOvw0zRnLHONr0bwV+3LnmwMqcjgJxDIbL9/5JCE6geslsb0ed2wcD0fReDjajP+Jh9MiJGOCPBmXTzJu0ellQY3/ycfG+agrH3fvdTz+57Kfj3+BdIw0ZdNq5V6B+urNGLWuZW7j8hUo6mLpMhBm5KyP49GdnfhFXTokktbsq0JnbYzdnTxnPDxmIkPGfxoz3IjJYkpkzmf8tCd9MhpGoVCM/rLIRHY+IcFlKjt8MGK5zDXdDtYjRIWpUUZF0+od58UYFQqeVOaQx6+tUMdCQSNMzu2rl/LI5teJS5H5KFMU547peRiEbNxFqpVPJ88680mr6ok1jnoEoVu+yjSz80A3C5l/oqI48yIqUkhoXWT6kvJgnN2Xy2QNplFiMnM8rWy/EQnPxE1zaFjz6LIWko376qU6t7avNlJ88+SwhlEcCo/w47dN6X60pjuIzK6Daotd0RYmlClGxlQgCim8w3PhbpU0WoFkDB6SMXhIx3ggk+3G9MtQlE2mAyA80B6u34C75PLNPD6NGhaLrKonjrIGmmRBYb7KI7/P5HQkDqsqpaMjTDmxqjgE0/kVpihZ2e2Jtx2o7cIVwsjnhVMaQHiOsbGXEAPTEd84ZqKE4df102F0MRqOcIyFE9kYD98fpoCjIxnJAH2sjoYQeu4WrtjKSH/GNMMjFFA9udQkTSUIR8T8EjIdGIqCSBal2jEAPcrqOwVEMt5UHUj9kzAxkwv05BJogCdbRKfiRbnJDTLumSwUG4sPTGjTfXSkMlFYVDRK3KumYaNZIxMgm09WJufvaC0GCOfFFm4HPDQIkK0JRiJrLN3Cctky8RaLGBVR8x68k8UaSGcqlwptt69OKomsYeER+iKHNYye8NcyZ2l8npH6BvqQ6Rj55BeHLovX2A8y0hCIuvdEaPH48UW6NClmxhwfCnMAp+qknZBxtCTBRy5c4O7XGumDUnct3EMuX2akcijrLXTZ5Jt9VBIN5YT5CHd50ewNrmVxg/esF1EHm0qF7cpaaUSUxgTSdb8ea6aEJYdXmaaHToySA9kkmh9Ip+NPXfIAWFiP/xn/IsziUC2sZ6Dp17V0FBrVshshjWOGtKewPsqQyRpKUSk8SI9Rsl3TRKt1YS3b+GvVnutjW5m4pGAS1rmNgiwM5dStCvfNWr1VvxhPRul4YXa5F8INeUyFzTLJh226DwlZ7aZ4LuryrVTvOqqsq/1e1fpspY7tkJP8ZnpCejwUMl9N8aZ89ASFnQwpzbaySujWFG/RSELEY01VOm5L6zGZD8PJC8e6KxTWnTbqaK5IWrsK+Xigy2WTqaV1oaNTEUseSFhPoGVN5SjoGhfSoFpsc2hsAyl0hTShUwtL90G4OGDhTqGlnU1qimBfuD83bV2ZnAh9YyUVDvz5ydxeaOWFMLnZnJ/+o7atu1et6RgJU3VUmFNtaqSfhcf65vzEMP0U+MJkSKv2ShcQGQQH5bMuVOBaNvb2KZi+GyQc+rY8qOpslpnRrULI+w1inBIaGn4KTyzMWNMgW0jeuliKjVrvGVIcENFKMhQWVdtC6DON+a9ctgE4ITXBtAyI5EPmdOVS/jGR2XJuVNF/UZuGaXRjF1YDnhu1Vy/F9tt2KK6x4xea3rtU8qIMnU6lLTn9xUPEm4yboxBgWmb/RXUyqfRUOU8MGyAZ4sQT4h4C13RFj1UQuJb5Uy2ROxEaDJkwEahlGc9Iubvx3UFh9HBuVPPMhW/mGNJzIso80JAxMAUZBIewBnr8WDzdYQmOhdzauyqMrDAtWUtlY8W9zEFLTscydtksDtK6F5BY3NLjqvC1GirT9+YrzTKhbHt7V09Nab1fQ1+4Q2Gx6X+ro7JXO2RGfZdgvf/8uDqVJ7Uvj2r18evPv//+/6VzCuo='; diff --git a/docs/assets/style.css b/docs/assets/style.css index 7c3fbdb9..973d4371 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,1640 +1,1623 @@ @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 { - --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; - } - + --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 { - /* 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. + --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; - } + 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 { - 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); + grid-template-columns: repeat(2, 1fr); } - .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; - } - /* + } + @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-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-search[open].closing { - animation-name: fade-out; + #tsd-toolbar-links { + display: none; } - /* 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; + .container-main { + display: flex; } - #tsd-search-results > li > a .parent { - color: var(--color-text-aside); + .col-content { + float: none; + max-width: 100%; + width: 100%; } - #tsd-search-results > li > a mark { - color: inherit; - background-color: inherit; - font-weight: bold; + .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-search-status { - flex: 1; - display: grid; - place-content: center; - text-align: center; - overflow-wrap: anywhere; + .col-sidebar > *:last-child { + padding-bottom: 20px; } - #tsd-search-status:not(:empty) { - min-height: 6rem; + .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-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; + .to-has-menu .overlay { + animation: fade-in 0.4s; } - .tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; } - .tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; + .from-has-menu .overlay { + animation: fade-out 0.4s; } - .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; + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; } - .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; + .has-menu body { + overflow: hidden; } - .tsd-page-toolbar a { - color: var(--color-text); + .has-menu .overlay { + visibility: visible; } - .tsd-toolbar-contents { - display: flex; - align-items: center; - height: var(--dim-toolbar-contents-height); - margin: 0 auto; + .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-toolbar-contents > .title { - font-weight: bold; - margin-right: auto; + .has-menu .tsd-navigation { + max-height: 100%; } - #tsd-toolbar-links { - display: flex; - align-items: center; - gap: 1.5rem; - margin-right: 1rem; + .tsd-navigation .tsd-nav-link { + display: flex; } + } - .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; + /* 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-member-summary-name { - display: inline-flex; - align-items: center; - padding: 0.25rem; - text-decoration: none; + .tsd-breadcrumb { + margin-top: 0; } - .tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - color: var(--color-text); - vertical-align: middle; + .col-sidebar { + grid-area: sidebar; } - - .tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; + .col-content { + grid-area: content; + padding: 0 1rem; } - - .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; + } + @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)); } - - .deprecated { - text-decoration: line-through !important; + .site-menu { + margin-top: 1rem; } + } - .warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); + /* 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-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); + .col-sidebar { + display: contents; } - /* if we have a kind icon, don't color the text by kind */ - .tsd-kind-icon ~ span { - color: var(--color-text); + .page-menu { + grid-area: toc; + padding-left: 1rem; } - - /* 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; - } + .site-menu { + grid-area: sidebar; } - /* 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; - } + .site-menu { + margin-top: 0rem; } - /* 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) - ); - } + .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/TimeoutError.html b/docs/classes/TimeoutError.html index 843ec717..a95a3cca 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,3 +1,500 @@ -TimeoutError | react-native-auth0
                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                      Class TimeoutError

                                                                                                                                                                                                                      Hierarchy (View Summary)

                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                      constructor -

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      type -

                                                                                                                                                                                                                      Constructors

                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                      type: string

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Constructors
                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                      + + + + + + TimeoutError | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                      +
                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                        Class TimeoutError

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        + Hierarchy (View Summary) +

                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                        +                                                                                                                                                                                                                         +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + constructor +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + type +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        Constructors

                                                                                                                                                                                                                        +                                                                                                                                                                                                                         +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                        +                                                                                                                                                                                                                         +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        + type: + string +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        +                                                                                                                                                                                                                         +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                        +                                                                                                                                                                                                                         +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + Constructors + + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + Properties + +
                                                                                                                                                                                                                        + + type +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        +
                                                                                                                                                                                                                        + + diff --git a/docs/classes/Types.Auth.html b/docs/classes/Types.Auth.html index 0549ebe7..66337e69 100644 --- a/docs/classes/Types.Auth.html +++ b/docs/classes/Types.Auth.html @@ -1,74 +1,2557 @@ -Auth | react-native-auth0
                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                          Class Auth

                                                                                                                                                                                                                          Class for interfacing with the Auth0 Authentication API endpoints.

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          https://auth0.com/docs/api/authentication

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          clientId -domain -

                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                          authorizeUrl -createUser -exchange -exchangeNativeSocial -loginWithEmail -loginWithOOB -loginWithOTP -loginWithRecoveryCode -loginWithSMS -logoutUrl -multifactorChallenge -passwordlessWithEmail -passwordlessWithSMS -passwordRealm -refreshToken -resetPassword -revoke -userInfo -

                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                          clientId: string

                                                                                                                                                                                                                          The Auth0 client ID

                                                                                                                                                                                                                          -
                                                                                                                                                                                                                          domain: string

                                                                                                                                                                                                                          The Auth0 tenant domain

                                                                                                                                                                                                                          -

                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                          • Completes the Passworldess authentication with an email connection that was started using <a href="#passwordlesswithemail" class="tsd-kind-method">passwordlessWithEmail</a>.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<Credentials>

                                                                                                                                                                                                                            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          • Log in a user using an Out Of Band authentication code after they have received the 'mfa_required' error. -The MFA token tells the server the username or email, password, and realm values sent on the first request.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Requires your client to have the MFA OOB Grant Type enabled. See Client Grant Types to learn how to enable it.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<Credentials>

                                                                                                                                                                                                                            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          • Log in a user using the One Time Password code after they have received the 'mfa_required' error. -The MFA token tells the server the username or email, password, and realm values sent on the first request.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Requires your client to have the MFA OTP Grant Type enabled. -See Client Grant Types to learn how to enable it.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<Credentials>

                                                                                                                                                                                                                            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          • Log in a user using a multi-factor authentication Recovery Code after they have received the 'mfa_required' error. -The MFA token tells the server the username or email, password, and realm values sent on the first request.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Requires your client to have the MFA Grant Type enabled. See Client Grant Types to learn how to enable it.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<Credentials>

                                                                                                                                                                                                                            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          • Completes the Passworldess authentication with an SMS connection that was started using <a href="#passwordlesswithsms" class="tsd-kind-method">passwordlessWithSMS</a>.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<Credentials>

                                                                                                                                                                                                                            A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          • Request a challenge for multi-factor authentication (MFA) based on the challenge types supported by the application and user. -The challenge type is how the user will get the challenge and prove possession. Supported challenge types include: "otp" and "oob".

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<MultifactorChallengeResponse>

                                                                                                                                                                                                                            <a href="../types/MultifactorChallengeOTPResponse.html" class="tsd-kind-type-alias">MultifactorChallengeOTPResponse</a>, <a href="../types/MultifactorChallengeOOBResponse.html" class="tsd-kind-type-alias">MultifactorChallengeOOBResponse</a>, or <a href="../types/MultifactorChallengeOOBWithBindingResponse.html" class="tsd-kind-type-alias">MultifactorChallengeOOBWithBindingResponse</a> depending -on the challenge type.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                          • Starts the Passworldess flow with an email connection.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            This should be completed later using a call to <a href="#loginwithemail" class="tsd-kind-method">loginWithEmail</a>, passing the OTP that was sent to the user.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                          • Starts the Passwordless flow with an SMS connection.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            This should be completed later using a call to <a href="#loginwithsms" class="tsd-kind-method">loginWithSMS</a>, passing the OTP that was sent to the user.

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                          + + + + + + Auth | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                          +
                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            Class Auth

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            + Class for interfacing with the Auth0 Authentication API endpoints. +

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                            + https://auth0.com/docs/api/authentication +

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                            +                                                                                                                                                                                                                             +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + clientId + + domain +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + authorizeUrl + + createUser + + exchange + + exchangeNativeSocial + + loginWithEmail + + loginWithOOB + + loginWithOTP + + loginWithRecoveryCode + + loginWithSMS + + logoutUrl + + multifactorChallenge + + passwordlessWithEmail + + passwordlessWithSMS + + passwordRealm + + refreshToken + + resetPassword + + revoke + + userInfo +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                            +                                                                                                                                                                                                                             +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            + clientId: + string +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            The Auth0 client ID

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            + domain: + string +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            The Auth0 tenant domain

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                            +                                                                                                                                                                                                                             +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Creates a new user using the options provided.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<Partial<User>> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + An instance of <a href="../types/User.html" + class="tsd-kind-type-alias">User</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Completes the Passworldess authentication with an email + connection that was started using <a + href="#passwordlesswithemail" + class="tsd-kind-method">passwordlessWithEmail</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<Credentials> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + A populated instance of <a + href="../types/Credentials.html" + class="tsd-kind-type-alias">Credentials</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Log in a user using an Out Of Band authentication code + after they have received the 'mfa_required' error. The + MFA token tells the server the username or email, + password, and realm values sent on the first request. +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Requires your client to have the + MFA OOB Grant Type enabled. See + Client Grant Types + to learn how to enable it. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<Credentials> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + A populated instance of <a + href="../types/Credentials.html" + class="tsd-kind-type-alias">Credentials</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Log in a user using the One Time Password code after + they have received the 'mfa_required' error. The MFA + token tells the server the username or email, password, + and realm values sent on the first request. +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Requires your client to have the + MFA OTP Grant Type enabled. See + Client Grant Types + to learn how to enable it. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<Credentials> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + A populated instance of <a + href="../types/Credentials.html" + class="tsd-kind-type-alias">Credentials</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Log in a user using a multi-factor authentication + Recovery Code after they have received the + 'mfa_required' error. The MFA token tells the server the + username or email, password, and realm values sent on + the first request. +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Requires your client to have the + MFA Grant Type enabled. See + Client Grant Types + to learn how to enable it. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<Credentials> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + A populated instance of <a + href="../types/Credentials.html" + class="tsd-kind-type-alias">Credentials</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Completes the Passworldess authentication with an SMS + connection that was started using <a + href="#passwordlesswithsms" + class="tsd-kind-method">passwordlessWithSMS</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<Credentials> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + A populated instance of <a + href="../types/Credentials.html" + class="tsd-kind-type-alias">Credentials</a>. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Request a challenge for multi-factor authentication + (MFA) based on the challenge types supported by the + application and user. The challenge type is how the user + will get the challenge and prove possession. Supported + challenge types include: "otp" and + "oob". +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<MultifactorChallengeResponse> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + <a + href="../types/MultifactorChallengeOTPResponse.html" + class="tsd-kind-type-alias">MultifactorChallengeOTPResponse</a>, + <a + href="../types/MultifactorChallengeOOBResponse.html" + class="tsd-kind-type-alias">MultifactorChallengeOOBResponse</a>, + or <a + href="../types/MultifactorChallengeOOBWithBindingResponse.html" + class="tsd-kind-type-alias">MultifactorChallengeOOBWithBindingResponse</a> + depending on the challenge type. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Starts the Passworldess flow with an email connection. +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + This should be completed later using a call to <a + href="#loginwithemail" + class="tsd-kind-method">loginWithEmail</a>, + passing the OTP that was sent to the user. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<void> +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Starts the Passwordless flow with an SMS connection. +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + This should be completed later using a call to <a + href="#loginwithsms" + class="tsd-kind-method">loginWithSMS</a>, + passing the OTP that was sent to the user. +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<void> +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Revoke an issued refresh token

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<void> +

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Return user information using an access token

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              + Returns Promise<User> +

                                                                                                                                                                                                                              +

                                                                                                                                                                                                                              The user's profile information.

                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            +                                                                                                                                                                                                                             +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                            +                                                                                                                                                                                                                             +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + Methods + + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            +
                                                                                                                                                                                                                            + + diff --git a/docs/classes/Types.BaseError.html b/docs/classes/Types.BaseError.html index b4fa730d..9d196195 100644 --- a/docs/classes/Types.BaseError.html +++ b/docs/classes/Types.BaseError.html @@ -1,3 +1,515 @@ -BaseError | react-native-auth0
                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                              Class BaseError

                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                              constructor -

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              type -

                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                              • Parameters

                                                                                                                                                                                                                                • name: string
                                                                                                                                                                                                                                • message: string
                                                                                                                                                                                                                                • Optionaltype: string

                                                                                                                                                                                                                                Returns BaseError

                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                              type: string

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                              + + + + + + BaseError | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                              +
                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                Class BaseError

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                + Hierarchy (View Summary) +

                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                +                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + constructor +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + type +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                +                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                  • + name: + string +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  • + message: + string +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  • + Optionaltype: + string +
                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                  + Returns + BaseError +

                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                +                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                + type: + string +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                +                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                +                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + Constructors + + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + Properties + +
                                                                                                                                                                                                                                + + type +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                + + diff --git a/docs/classes/Types.CredentialsManager.html b/docs/classes/Types.CredentialsManager.html index c6e9c9a7..fa87d1e7 100644 --- a/docs/classes/Types.CredentialsManager.html +++ b/docs/classes/Types.CredentialsManager.html @@ -1,16 +1,768 @@ -CredentialsManager | react-native-auth0
                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                  Class CredentialsManager

                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                  clearCredentials -getCredentials -hasValidCredentials -saveCredentials -

                                                                                                                                                                                                                                  Methods

                                                                                                                                                                                                                                  • Gets the credentials that has already been saved

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • Optionalscope: string

                                                                                                                                                                                                                                      The scope to request for the access token. If null is passed, the previous scope will be kept.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • minTtl: number = 0

                                                                                                                                                                                                                                      The minimum time in seconds that the access token should last before expiration.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • parameters: Record<string, unknown> = {}

                                                                                                                                                                                                                                      Additional parameters to send in the request to refresh expired credentials.

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                    • forceRefresh: boolean = false

                                                                                                                                                                                                                                      Whether to force refresh the credentials. It will work only if the refresh token already exists. For iOS, doing forceRefresh will not send the scope. Since scope change already does force refresh, it is better to avoid force refresh if the scope is being changed.

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<Credentials>

                                                                                                                                                                                                                                    A populated instance of <a href="../types/Credentials.html" class="tsd-kind-type-alias">Credentials</a>.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  • Returns whether this manager contains a valid non-expired pair of credentials.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • minTtl: number = 0

                                                                                                                                                                                                                                      The minimum time in seconds that the access token should last before expiration

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                    Returns Promise<boolean>

                                                                                                                                                                                                                                    true if a valid set of credentials are available, or false if there are no credentials to return.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                  Methods
                                                                                                                                                                                                                                  + + + + + + CredentialsManager | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    Class CredentialsManager

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + clearCredentials + + getCredentials + + hasValidCredentials + + saveCredentials +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                    Methods

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Delete the stored credentials

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      + Returns Promise<void> +

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Gets the credentials that has already been saved

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • + Optionalscope: + string +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        + The scope to request for the access token. If null + is passed, the previous scope will be kept. +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      • + minTtl: + number + = 0 +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        + The minimum time in seconds that the access token + should last before expiration. +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      • + parameters: + Record<string, + unknown> + = {} +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        + Additional parameters to send in the request to + refresh expired credentials. +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      • + forceRefresh: boolean + = false +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        + Whether to force refresh the credentials. It will + work only if the refresh token already exists. For + iOS, doing forceRefresh will not send the scope. + Since scope change already does force refresh, it + is better to avoid force refresh if the scope is + being changed. +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      + Returns Promise<Credentials> +

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      + A populated instance of <a + href="../types/Credentials.html" + class="tsd-kind-type-alias">Credentials</a>. +

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      + Returns whether this manager contains a valid + non-expired pair of credentials. +

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                      • + minTtl: + number + = 0 +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        + The minimum time in seconds that the access token + should last before expiration +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      + Returns Promise<boolean> +

                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                      + true if a valid set of credentials are + available, or false if there are no + credentials to return. +

                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + Methods + + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + + diff --git a/docs/classes/Types.Users.html b/docs/classes/Types.Users.html index eef23870..7c58f4d5 100644 --- a/docs/classes/Types.Users.html +++ b/docs/classes/Types.Users.html @@ -1,16 +1,688 @@ -Users | react-native-auth0
                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                      Class Users

                                                                                                                                                                                                                                      Auth0 Management API User endpoints

                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      https://auth0.com/docs/api/management/v2#!/Users/ -Users

                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                      getUser -patchUser -

                                                                                                                                                                                                                                      Methods

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                      Methods
                                                                                                                                                                                                                                      + + + + + + Users | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        Class Users

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Auth0 Management API User endpoints

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        + https://auth0.com/docs/api/management/v2#!/Users/ + Users +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + getUser + + patchUser +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                        Methods

                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + Methods + + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + + diff --git a/docs/classes/Types.WebAuth.html b/docs/classes/Types.WebAuth.html index 86081e73..1eca837f 100644 --- a/docs/classes/Types.WebAuth.html +++ b/docs/classes/Types.WebAuth.html @@ -1,18 +1,707 @@ -WebAuth | react-native-auth0
                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                          Class WebAuth

                                                                                                                                                                                                                                          Helper to perform Auth against Auth0 hosted login page

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          It will use /authorize endpoint of the Authorization Server (AS) -with Code Grant and Proof Key for Challenge Exchange (PKCE).

                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          https://auth0.com/docs/api-auth/grant/authorization-code-pkce

                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          authorize -cancelWebAuth -clearSession -

                                                                                                                                                                                                                                          Methods

                                                                                                                                                                                                                                          • Terminates the ongoing web-based operation and reports back that it was cancelled. -You need to call this method within your custom Web Auth provider implementation whenever the operation is -cancelled by the user.

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Returns Promise<void>

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                          Methods
                                                                                                                                                                                                                                          + + + + + + WebAuth | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            Class WebAuth

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Helper to perform Auth against Auth0 hosted login page

                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            + It will use /authorize endpoint of the Authorization + Server (AS) with Code Grant and Proof Key for Challenge Exchange + (PKCE). +

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                            + https://auth0.com/docs/api-auth/grant/authorization-code-pkce +

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + authorize + + cancelWebAuth + + clearSession +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            Methods

                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              + Terminates the ongoing web-based operation and reports + back that it was cancelled. You need to call this method + within your custom Web Auth provider implementation + whenever the operation is cancelled by the user. +

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                              + Returns Promise<void> +

                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + Methods + + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                            + + diff --git a/docs/classes/default.html b/docs/classes/default.html index b4a821f0..3838d9c5 100644 --- a/docs/classes/default.html +++ b/docs/classes/default.html @@ -1,18 +1,820 @@ -default | react-native-auth0
                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                              Class default

                                                                                                                                                                                                                                              Auth0 for React Native client

                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                              constructor -

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              auth -credentialsManager -webAuth -

                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                              users -

                                                                                                                                                                                                                                              Constructors

                                                                                                                                                                                                                                              • Creates an instance of Auth0.

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                • options: Auth0Options

                                                                                                                                                                                                                                                  Your Auth0 application information

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Options for configuring the Auth0 client.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  • clientId: string

                                                                                                                                                                                                                                                    The client identifier of your application.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • domain: string

                                                                                                                                                                                                                                                    The Auth0 domain for your tenant.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • Optionalheaders?: Record<string, string>

                                                                                                                                                                                                                                                    (Optional) Custom headers to include in requests.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • OptionallocalAuthenticationOptions?: LocalAuthenticationOptions

                                                                                                                                                                                                                                                    Options for configuring local authentication.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • Optionaltelemetry?: Telemetry

                                                                                                                                                                                                                                                    Telemetry information to include in requests.

                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                  • Optionaltimeout?: number

                                                                                                                                                                                                                                                    The timeout in milliseconds for network requests.

                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                Returns default

                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                              auth: Auth
                                                                                                                                                                                                                                              credentialsManager: CredentialsManager
                                                                                                                                                                                                                                              webAuth: WebAuth

                                                                                                                                                                                                                                              Methods

                                                                                                                                                                                                                                              • Creates a Users API client

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                • token: string

                                                                                                                                                                                                                                                  for Management API

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                Returns Users

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                              Constructors
                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                              Methods
                                                                                                                                                                                                                                              + + + + + + default | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                Class default

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Auth0 for React Native client

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + constructor +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + auth + + credentialsManager + + webAuth +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + users +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                Constructors

                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Creates an instance of Auth0.

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                  • + options: + Auth0Options +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Your Auth0 application information

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Options for configuring the Auth0 client.

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                      + clientId: string +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      + The client identifier of your application. +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                      + domain: string +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      The Auth0 domain for your tenant.

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                      + Optionalheaders?: Record<string, + string> +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      + (Optional) Custom headers to include in + requests. +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                      + OptionallocalAuthenticationOptions?: LocalAuthenticationOptions +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      + Options for configuring local authentication. +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                      + Optionaltelemetry?: Telemetry +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      + Telemetry information to include in requests. +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                      + Optionaltimeout?: number +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                      + The timeout in milliseconds for network + requests. +

                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  + Returns + default +

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                + auth: + Auth +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                + credentialsManager: + CredentialsManager +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                + webAuth: + WebAuth +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                Methods

                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Creates a Users API client

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                  • + token: + string +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    for Management API

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                  + Returns + Users +

                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + Constructors + + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + Methods + + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                + + diff --git a/docs/enums/LocalAuthenticationLevel.html b/docs/enums/LocalAuthenticationLevel.html index b6164f70..35a48a20 100644 --- a/docs/enums/LocalAuthenticationLevel.html +++ b/docs/enums/LocalAuthenticationLevel.html @@ -1,8 +1,464 @@ -LocalAuthenticationLevel | react-native-auth0
                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                  Enumeration LocalAuthenticationLevel

                                                                                                                                                                                                                                                  Used for Android only: The level of local authentication required to access the credentials. Defaults to LocalAuthenticationLevel.strong.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                  Enumeration Members

                                                                                                                                                                                                                                                  deviceCredential -strong -weak -

                                                                                                                                                                                                                                                  Enumeration Members

                                                                                                                                                                                                                                                  deviceCredential: 2

                                                                                                                                                                                                                                                  The non-biometric credential used to secure the device (i. e. PIN, pattern, or password).

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  strong: 0

                                                                                                                                                                                                                                                  Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for Class 3 (formerly Strong), as defined by the Android CDD.

                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                  weak: 1

                                                                                                                                                                                                                                                  Any biometric (e.g. fingerprint, iris, or face) on the device that meets or exceeds the requirements for Class 2 (formerly Weak), as defined by the Android CDD.

                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                  Enumeration Members
                                                                                                                                                                                                                                                  + + + + + + LocalAuthenticationLevel | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                    Enumeration LocalAuthenticationLevel

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    + Used for Android only: The level of local + authentication required to access the credentials. Defaults to + LocalAuthenticationLevel.strong. +

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    Enumeration Members

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + deviceCredential + + strong + + weak +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    Enumeration Members

                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    + deviceCredential: + 2 +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    + The non-biometric credential used to secure the device (i. e. + PIN, pattern, or password). +

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    + strong: + 0 +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    + Any biometric (e.g. fingerprint, iris, or face) on the device + that meets or exceeds the requirements for Class 3 (formerly + Strong), as defined by the Android CDD. +

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    + weak: + 1 +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    + Any biometric (e.g. fingerprint, iris, or face) on the device + that meets or exceeds the requirements for Class 2 (formerly + Weak), as defined by the Android CDD. +

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + Enumeration Members + + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                    + + diff --git a/docs/enums/LocalAuthenticationStrategy.html b/docs/enums/LocalAuthenticationStrategy.html index b6061f87..d59ab18e 100644 --- a/docs/enums/LocalAuthenticationStrategy.html +++ b/docs/enums/LocalAuthenticationStrategy.html @@ -1,6 +1,417 @@ -LocalAuthenticationStrategy | react-native-auth0
                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                      Enumeration LocalAuthenticationStrategy

                                                                                                                                                                                                                                                      Used for iOS only: The evaluation policy to use when accessing the credentials. Defaults to LocalAuthenticationStrategy.deviceOwnerWithBiometrics.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                      Enumeration Members

                                                                                                                                                                                                                                                      deviceOwner -deviceOwnerWithBiometrics -

                                                                                                                                                                                                                                                      Enumeration Members

                                                                                                                                                                                                                                                      deviceOwner: 2

                                                                                                                                                                                                                                                      User authentication with biometry, Apple Watch, or the device passcode.

                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                      deviceOwnerWithBiometrics: 1

                                                                                                                                                                                                                                                      User authentication with biometry.

                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                      Enumeration Members
                                                                                                                                                                                                                                                      + + + + + + LocalAuthenticationStrategy | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                        Enumeration LocalAuthenticationStrategy

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        + Used for iOS only: The evaluation policy to use + when accessing the credentials. Defaults to + LocalAuthenticationStrategy.deviceOwnerWithBiometrics. +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Enumeration Members

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + deviceOwner + + deviceOwnerWithBiometrics +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                        Enumeration Members

                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        + deviceOwner: + 2 +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        + User authentication with biometry, Apple Watch, or the device + passcode. +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        + deviceOwnerWithBiometrics: + 1 +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        User authentication with biometry.

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + Enumeration Members + + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                        + + diff --git a/docs/enums/SafariViewControllerPresentationStyle.html b/docs/enums/SafariViewControllerPresentationStyle.html index 22546608..f00fe6dd 100644 --- a/docs/enums/SafariViewControllerPresentationStyle.html +++ b/docs/enums/SafariViewControllerPresentationStyle.html @@ -1,13 +1,766 @@ -SafariViewControllerPresentationStyle | react-native-auth0
                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                          Enumeration SafariViewControllerPresentationStyle

                                                                                                                                                                                                                                                          Presentation styles for when using SFSafariViewController on iOS. -For the full description of what each option does, please see <a href="https://developer.apple.com/documentation/uikit/uimodalpresentationstyle">https://developer.apple.com/documentation/uikit/uimodalpresentationstyle&lt;/a&gt; for more details

                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                          Enumeration Members

                                                                                                                                                                                                                                                          automatic -currentContext -custom -formSheet -fullScreen -none -overCurrentContext -overFullScreen -pageSheet -popover -

                                                                                                                                                                                                                                                          Enumeration Members

                                                                                                                                                                                                                                                          automatic: -2
                                                                                                                                                                                                                                                          currentContext: 3
                                                                                                                                                                                                                                                          custom: 4
                                                                                                                                                                                                                                                          formSheet: 2
                                                                                                                                                                                                                                                          fullScreen: 0
                                                                                                                                                                                                                                                          none: -1
                                                                                                                                                                                                                                                          overCurrentContext: 6
                                                                                                                                                                                                                                                          overFullScreen: 5
                                                                                                                                                                                                                                                          pageSheet: 1
                                                                                                                                                                                                                                                          popover: 7

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                          Enumeration Members
                                                                                                                                                                                                                                                          + + + + + + SafariViewControllerPresentationStyle | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                            Enumeration SafariViewControllerPresentationStyle

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            + Presentation styles for when using SFSafariViewController on iOS. + For the full description of what each option does, please see + <a href="https://developer.apple.com/documentation/uikit/uimodalpresentationstyle">https://developer.apple.com/documentation/uikit/uimodalpresentationstyle&lt;/a&gt; for more details +

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            Enumeration Members

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + automatic + + currentContext + + custom + + formSheet + + fullScreen + + none + + overCurrentContext + + overFullScreen + + pageSheet + + popover +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                            Enumeration Members

                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + automatic: + -2 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + currentContext: + 3 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + custom: + 4 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + formSheet: + 2 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + fullScreen: + 0 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + none: + -1 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + overCurrentContext: + 6 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + overFullScreen: + 5 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + pageSheet: + 1 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            + popover: + 7 +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + Enumeration Members + + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                            + + diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 9c3e733f..ca677a15 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -1,6 +1,449 @@ -Auth0Provider | react-native-auth0
                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                              Function Auth0Provider

                                                                                                                                                                                                                                                              • Provides the Auth0Context to its child components.

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                Returns Element

                                                                                                                                                                                                                                                                &lt;Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"&gt;
                                                                                                                                                                                                                                                                  &lt;App /&gt;
                                                                                                                                                                                                                                                                &lt;/Auth0Provider&gt;
+
+
+  
+    
+    
+    Auth0Provider | react-native-auth0
+    
+    
+    
+    
+    
+    
+    
+    
+    
+  
+  
+    
+    
                                                                                                                                                                                                                                                                
+      
                                                                                                                                                                                                                                                                
+        react-native-auth0
+        
+        
+        
+          
+          
                                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                                  
+            
                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                                  
+                                                                                                                                                                                                                                                                          
+        
+      
                                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                                  
+    
                                                                                                                                                                                                                                                                  
+      
                                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                                  
+          
+          
                                                                                                                                                                                                                                                                  Function Auth0Provider
                                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                                  
+        
                                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                                    
+            
                                                                                                                                                                                                                                                                  • 
+              
+              
                                                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                                                    Provides the Auth0Context to its child components.
                                                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                                                      
+                    
                                                                                                                                                                                                                                                                    • 
+                      __namedParameters:
+                        PropsWithChildren<Auth0Options>
+                    
                                                                                                                                                                                                                                                                      • 
+                  
                                                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                                                    
+                  Returns Element
+                
                                                                                                                                                                                                                                                                    
+                
                                                                                                                                                                                                                                                                    
+                  
                                                                                                                                                                                                                                                                    
+                    
+                    
                                                                                                                                                                                                                                                                    &lt;Auth0Provider domain="YOUR AUTH0 DOMAIN" clientId="YOUR CLIENT ID"&gt;
                                                                                                                                                                                                                                                                      &lt;App /&gt;
                                                                                                                                                                                                                                                                    &lt;/Auth0Provider&gt;
 
                                                                                                                                                                                                                                                                    
-
-
                                                                                                                                                                                                                                                                  Index
                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  propTypes
-
                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  propTypes: {
                                                                                                                                                                                                                                                                      children: Validator<ReactElementLike>;
                                                                                                                                                                                                                                                                      clientId: Validator<string>;
                                                                                                                                                                                                                                                                      domain: Validator<string>;
                                                                                                                                                                                                                                                                      headers: Requireable<object>;
                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                  Settings
                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                  On This Page
                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                  
+
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  + +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + propTypes +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                + propTypes: + {
                                                                                                                                                                                                                                                                    children: + Validator<ReactElementLike>;
                                                                                                                                                                                                                                                                    clientId: + Validator<string>;
                                                                                                                                                                                                                                                                    domain: + Validator<string>;
                                                                                                                                                                                                                                                                    headers: + Requireable<object>;
                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                + + diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 310a8fff..1771a9e4 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -1,7 +1,280 @@ -useAuth0 | react-native-auth0
                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                  Function useAuth0

                                                                                                                                                                                                                                                                  • Use the useAuth0 in your function components to access authentication state and methods.

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Returns Auth0ContextInterface<User>

                                                                                                                                                                                                                                                                    The useAuth0 hook interface

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    const {
                                                                                                                                                                                                                                                                      // State
                                                                                                                                                                                                                                                                      error,
                                                                                                                                                                                                                                                                      user,
                                                                                                                                                                                                                                                                      isLoading,
                                                                                                                                                                                                                                                                      // Methods
                                                                                                                                                                                                                                                                      authorize,
                                                                                                                                                                                                                                                                      sendSMSCode,
                                                                                                                                                                                                                                                                      authorizeWithSMS,
                                                                                                                                                                                                                                                                      sendEmailCode,
                                                                                                                                                                                                                                                                      authorizeWithEmail,
                                                                                                                                                                                                                                                                      sendMultifactorChallenge,
                                                                                                                                                                                                                                                                      authorizeWithOOB,
                                                                                                                                                                                                                                                                      authorizeWithOTP,
                                                                                                                                                                                                                                                                      authorizeWithRecoveryCode,
                                                                                                                                                                                                                                                                      hasValidCredentials,
                                                                                                                                                                                                                                                                      clearSession,
                                                                                                                                                                                                                                                                      getCredentials,
                                                                                                                                                                                                                                                                      clearCredentials,
                                                                                                                                                                                                                                                                      requireLocalAuthentication,
                                                                                                                                                                                                                                                                      authorizeWithPasswordRealm,
                                                                                                                                                                                                                                                                      authorizeWithExchangeNativeSocial,
                                                                                                                                                                                                                                                                      revokeRefreshToken
                                                                                                                                                                                                                                                                    } = useAuth0();
+
+
+  
+    
+    
+    useAuth0 | react-native-auth0
+    
+    
+    
+    
+    
+    
+    
+    
+    
+  
+  
+    
+    
                                                                                                                                                                                                                                                                    
+      
                                                                                                                                                                                                                                                                    
+        react-native-auth0
+        
+        
+        
+          
+          
                                                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                                                      
+            
                                                                                                                                                                                                                                                                      Preparing search index...
                                                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                                                      
+                                                                                                                                                                                                                                                                              
+        
+      
                                                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                                                      
+    
                                                                                                                                                                                                                                                                      
+      
                                                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                                                      
+          
+          
                                                                                                                                                                                                                                                                      Function useAuth0
                                                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                                                      
+        
                                                                                                                                                                                                                                                                      
+          
                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                      • 
+              
+              
                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                        
+                  
                                                                                                                                                                                                                                                                        
+                    Use the useAuth0 in your function components to
+                    access authentication state and methods.
+                  
                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                        
+                  Returns
+                  Auth0ContextInterface<User>
+                
                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                        The useAuth0 hook interface
                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                        const {
                                                                                                                                                                                                                                                                          // State
                                                                                                                                                                                                                                                                          error,
                                                                                                                                                                                                                                                                          user,
                                                                                                                                                                                                                                                                          isLoading,
                                                                                                                                                                                                                                                                          // Methods
                                                                                                                                                                                                                                                                          authorize,
                                                                                                                                                                                                                                                                          sendSMSCode,
                                                                                                                                                                                                                                                                          authorizeWithSMS,
                                                                                                                                                                                                                                                                          sendEmailCode,
                                                                                                                                                                                                                                                                          authorizeWithEmail,
                                                                                                                                                                                                                                                                          sendMultifactorChallenge,
                                                                                                                                                                                                                                                                          authorizeWithOOB,
                                                                                                                                                                                                                                                                          authorizeWithOTP,
                                                                                                                                                                                                                                                                          authorizeWithRecoveryCode,
                                                                                                                                                                                                                                                                          hasValidCredentials,
                                                                                                                                                                                                                                                                          clearSession,
                                                                                                                                                                                                                                                                          getCredentials,
                                                                                                                                                                                                                                                                          clearCredentials,
                                                                                                                                                                                                                                                                          requireLocalAuthentication,
                                                                                                                                                                                                                                                                          authorizeWithPasswordRealm,
                                                                                                                                                                                                                                                                          authorizeWithExchangeNativeSocial,
                                                                                                                                                                                                                                                                          revokeRefreshToken
                                                                                                                                                                                                                                                                        } = useAuth0();
 
                                                                                                                                                                                                                                                                        
 
-
                                                                                                                                                                                                                                                                        Refer to <a href="../interfaces/Types.Auth0ContextInterface.html" class="tsd-kind-interface">Auth0ContextInterface</a> on how to use the above methods.
                                                                                                                                                                                                                                                                        
-
                                                                                                                                                                                                                                                                      Settings
                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                                                      
+                  Refer to <a
+                  href="../interfaces/Types.Auth0ContextInterface.html"
+                  class="tsd-kind-interface">Auth0ContextInterface</a>
+                  on how to use the above methods.
+                
                                                                                                                                                                                                                                                                      
+                
                                                                                                                                                                                                                                                                      
+                
+
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                    + + diff --git a/docs/hierarchy.html b/docs/hierarchy.html index a10b8b89..811982dd 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1,253 @@ -react-native-auth0
                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                      react-native-auth0

                                                                                                                                                                                                                                                                      Hierarchy Summary

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                      + + + + + + react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        react-native-auth0

                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Hierarchy Summary

                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                        + + diff --git a/docs/index.html b/docs/index.html index 8c1bc97d..401fdf29 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,56 +1,342 @@ -react-native-auth0
                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                          react-native-auth0

                                                                                                                                                                                                                                                                          react-native-auth0

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Build Status -NPM version -Coverage -License -Downloads -FOSSA Status

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          📚 Documentation • 🚀 Getting Started • ⏭️ Next Steps • ❓ FAQs • ❓ Feedback

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          We're excited to announce the release of react-native-auth0 v4.0.0! Please note that this update includes breaking changes that require your attention. To ensure a smooth transition, please review our -👉 Migration Guide 👈 for detailed instructions on updating your integration.

                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          This SDK targets apps that are using React Native SDK version 0.65.0 and up. If you're using an older React Native version, see the compatibility matrix below.

                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          The following shows platform minimums for running projects with this SDK:

                                                                                                                                                                                                                                                                          - - - - - - - - - - - - - - - - - -
                                                                                                                                                                                                                                                                          PlatformMinimum version
                                                                                                                                                                                                                                                                          iOS13.0
                                                                                                                                                                                                                                                                          Android34
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Our SDK requires a minimum iOS deployment target of 13.0. In your project's ios/Podfile, ensure your platform target is set to 13.0.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          platform :ios, '13.0'
+
+
+  
+    
+    
+    react-native-auth0
+    
+    
+    
+    
+    
+    
+    
+    
+    
+  
+  
+    
+    
                                                                                                                                                                                                                                                                          
+      
                                                                                                                                                                                                                                                                          
+        react-native-auth0
+        
+        
+        
+          
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            
                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+                                                                                                                                                                                                                                                                                    
+        
+      
                                                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                                                            
+    
                                                                                                                                                                                                                                                                            
+      
                                                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                            
+        
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            react-native-auth0
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Build Status
+            NPM version
+            Coverage
+            License
+            Downloads
+            FOSSA Status
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            📚 Documentation • 🚀
+            Getting Started • ⏭️
+            Next Steps • ❓
+            FAQs
+            • ❓ Feedback
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            We're excited to announce the release of react-native-auth0
+            v4.0.0! Please note that this update includes breaking
+            changes that require your attention. To ensure a smooth transition,
+            please review our 👉
+            Migration Guide
+            👈 for detailed instructions on updating your integration.
+          
                                                                                                                                                                                                                                                                            
+          
+          
+          
+          
+          
                                                                                                                                                                                                                                                                            
+            This SDK targets apps that are using React Native SDK version
+            0.65.0 and up. If you're using an older React Native
+            version, see the compatibility matrix below.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            The following shows platform minimums for running projects with this
+            SDK:
+          
                                                                                                                                                                                                                                                                            
+          
+            
+              
+                
+                
+              
+            
+            
+              
+                
+                
+              
+              
+                
+                
+              
+            
+          
                                                                                                                                                                                                                                                                            PlatformMinimum version
                                                                                                                                                                                                                                                                            iOS13.0
                                                                                                                                                                                                                                                                            Android34
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Our SDK requires a minimum iOS deployment target of 13.0. In your
+            project's ios/Podfile, ensure your platform target is set to 13.0.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            platform :ios, '13.0'
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            First install the native library module:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            $ npm install react-native-auth0 --save
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            $ yarn add react-native-auth0
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Then, you need to run the following command to install the ios app pods with Cocoapods. That will auto-link the iOS library:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            $ cd ios && pod install
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            You need to make your Android, iOS or Expo applications aware that an authentication result will be received from the browser. This SDK makes use of the Android's Package Name and its analogous iOS's Product Bundle Identifier to generate the redirect URL. Each platform has its own set of instructions.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > Before version 2.9.0, this SDK required you to add an intent filter to the Activity on which you're going to receive the authentication result, and to use the singleTask launchMode in that activity. To migrate your app to version 2.9.0+, remove both and continue with the instructions below.
-> You can also check out a sample migration diff here.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Open your app's build.gradle file (typically at android/app/build.gradle) and add the following manifest placeholders:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            android {
+          
+          
                                                                                                                                                                                                                                                                            First install the native library module:
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            $ npm install react-native-auth0 --save
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            $ yarn add react-native-auth0
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Then, you need to run the following command to install the ios app
+            pods with Cocoapods. That will auto-link the iOS library:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            $ cd ios && pod install
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            You need to make your Android, iOS or Expo applications aware that
+            an authentication result will be received from the browser. This SDK
+            makes use of the Android's Package Name and its analogous iOS's
+            Product Bundle Identifier to generate the redirect URL. Each
+            platform has its own set of instructions.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            > Before version 2.9.0, this SDK required you to add an intent
+            filter to the Activity on which you're going to receive the
+            authentication result, and to use the singleTask
+            launchMode in that activity. To migrate your app to
+            version 2.9.0+, remove both and continue with the
+            instructions below. > You can also check out a sample migration
+            diff
+            here.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Open your app's build.gradle file (typically at
+            android/app/build.gradle) and add the following
+            manifest placeholders:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            android {
     defaultConfig {
         // Add the next line
         manifestPlaceholders = [auth0Domain: "YOUR_AUTH0_DOMAIN", auth0Scheme: "${applicationId}.auth0"]
@@ -59,8 +345,12 @@ 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            The auth0Domain value must be replaced with your Auth0 domain value. So if you have samples.us.auth0.com as your Auth0 domain you would have a configuration like the following:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            android {
+          
                                                                                                                                                                                                                                                                            
+            The auth0Domain value must be replaced with your Auth0
+            domain value. So if you have samples.us.auth0.com as
+            your Auth0 domain you would have a configuration like the following:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            android {
     defaultConfig {
         manifestPlaceholders = [auth0Domain: "samples.us.auth0.com", auth0Scheme: "${applicationId}.auth0"]
     }
@@ -68,14 +358,65 @@ 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            The applicationId value will be auto-replaced at runtime with the package name or ID of your application (e.g. com.example.app). You can change this value from the build.gradle file. You can also check it at the top of your AndroidManifest.xml file.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > Note that if your Android application is using product flavors, you might need to specify different manifest placeholders for each flavor.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            If you use a value other than applicationId in auth0Scheme you will also need to pass it as the customScheme option parameter of the authorize and clearSession methods.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Take note of this value as you'll be requiring it to define the callback URLs below.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > For more info please read the React Native docs.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            If you don't plan to use Web Authentication, you will notice that the compiler will still prompt you to provide the manifestPlaceholders values, since the RedirectActivity included in this library will require them, and the Gradle tasks won't be able to run without them.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Re-declare the activity manually with tools:node="remove" in your app's Android Manifest in order to make the manifest merger remove it from the final manifest file. Additionally, one more unused activity can be removed from the final APK by using the same process. A complete snippet to achieve this is:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            <activity
+          
                                                                                                                                                                                                                                                                            
+            The applicationId value will be auto-replaced at
+            runtime with the package name or ID of your application (e.g.
+            com.example.app). You can change this value from the
+            build.gradle file. You can also check it at the top of
+            your AndroidManifest.xml file.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > Note that if your Android application is using
+            product flavors, you might need to specify different manifest placeholders for
+            each flavor.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            If you use a value other than applicationId in
+            auth0Scheme you will also need to pass it as the
+            customScheme option parameter of the
+            authorize and clearSession methods.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Take note of this value as you'll be requiring it to define the
+            callback URLs below.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > For more info please read the
+            React Native docs.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            If you don't plan to use Web Authentication, you will notice that
+            the compiler will still prompt you to provide the
+            manifestPlaceholders values, since the
+            RedirectActivity included in this library will require
+            them, and the Gradle tasks won't be able to run without them.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Re-declare the activity manually with
+            tools:node="remove" in your app's Android
+            Manifest in order to make the manifest merger remove it from the
+            final manifest file. Additionally, one more unused activity can be
+            removed from the final APK by using the same process. A complete
+            snippet to achieve this is:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            <activity
     android:name="com.auth0.android.provider.AuthenticationActivity"
     tools:node="remove"/>
 <!-- Optional: Remove RedirectActivity -->
@@ -84,8 +425,17 @@ 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            Inside the ios folder find the file AppDelegate.[swift|m] add the following to it:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            #import <React/RCTLinkingManager.h>
+          
+          
                                                                                                                                                                                                                                                                            
+            Inside the ios folder find the file
+            AppDelegate.[swift|m] add the following to it:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            #import <React/RCTLinkingManager.h>
 
 - (BOOL)application:(UIApplication *)app openURL:(NSURL *)url
             options:(NSDictionary<UIApplicationOpenURLOptionsKey, id> *)options
@@ -94,13 +444,21 @@ 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            Inside the ios folder open the Info.plist and locate the value for CFBundleIdentifier, e.g.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            <key>CFBundleIdentifier</key>
+          
                                                                                                                                                                                                                                                                            
+            Inside the ios folder open the
+            Info.plist and locate the value for
+            CFBundleIdentifier, e.g.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            <key>CFBundleIdentifier</key>
 <string>$(PRODUCT_BUNDLE_IDENTIFIER)</string>
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            and then below it register a URL type entry using the value of CFBundleIdentifier as the value for CFBundleURLSchemes:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            <key>CFBundleURLTypes</key>
+          
                                                                                                                                                                                                                                                                            
+            and then below it register a URL type entry using the value of
+            CFBundleIdentifier as the value for
+            CFBundleURLSchemes:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            <key>CFBundleURLTypes</key>
 <array>
     <dict>
         <key>CFBundleTypeRole</key>
@@ -115,361 +473,1397 @@ 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            If your application is generated using the React Native CLI, the default value of $(PRODUCT_BUNDLE_IDENTIFIER) matches org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier). Take note of this value as you'll be requiring it to define the callback URLs below. If desired, you can change its value using XCode in the following way:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                              
-
                                                                                                                                                                                                                                                                            • Open the ios/TestApp.xcodeproj file replacing 'TestApp' with the name of your app or run xed ios from a Terminal.
                                                                                                                                                                                                                                                                              • 
-
                                                                                                                                                                                                                                                                            • Open your project's or desired target's Build Settings tab and on the search bar at the right type "Product Bundle Identifier".
                                                                                                                                                                                                                                                                              • 
-
                                                                                                                                                                                                                                                                            • Replace the Product Bundle Identifier value with your desired application's bundle identifier name (e.g. com.example.app).
                                                                                                                                                                                                                                                                              • 
-
                                                                                                                                                                                                                                                                            • If you've changed the project wide settings, make sure the same were applied to each of the targets your app has.
                                                                                                                                                                                                                                                                              • 
-
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            If you use a value other than $(PRODUCT_BUNDLE_IDENTIFIER) in the CFBundleURLSchemes field of the Info.plist you will also need to pass it as the customScheme option parameter of the authorize and clearSession methods.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > For more info please read the React Native docs.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > :warning: This SDK is not compatible with "Expo Go" app because of custom native code. It is compatible with Custom Dev Client and EAS builds
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            To use the SDK with Expo, configure the app at build time by providing the domain and the customScheme values through the Config Plugin. To do this, add the following snippet to app.json or app.config.js:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                              "expo": {
                                                                                                                                                                                                                                                                                ...
                                                                                                                                                                                                                                                                                "plugins": [
                                                                                                                                                                                                                                                                                  [
                                                                                                                                                                                                                                                                                    "react-native-auth0",
                                                                                                                                                                                                                                                                                    {
                                                                                                                                                                                                                                                                                      "domain": "YOUR_AUTH0_DOMAIN",
                                                                                                                                                                                                                                                                                      "customScheme": "YOUR_CUSTOM_SCHEME"
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                  ]
                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                            }
+          
                                                                                                                                                                                                                                                                            
+            If your application is generated using the React Native CLI, the
+            default value of $(PRODUCT_BUNDLE_IDENTIFIER) matches
+            org.reactjs.native.example.$(PRODUCT_NAME:rfc1034identifier). Take note of this value as you'll be requiring it to define the
+            callback URLs below. If desired, you can change its value using
+            XCode in the following way:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                                                            • 
+              Open the ios/TestApp.xcodeproj file replacing
+              'TestApp' with the name of your app or run
+              xed ios from a Terminal.
+            
                                                                                                                                                                                                                                                                              • 
+            
                                                                                                                                                                                                                                                                            • 
+              Open your project's or desired target's
+              Build Settings tab and on the search bar at the
+              right type "Product Bundle Identifier".
+            
                                                                                                                                                                                                                                                                              • 
+            
                                                                                                                                                                                                                                                                            • 
+              Replace the Product Bundle Identifier value with
+              your desired application's bundle identifier name (e.g.
+              com.example.app).
+            
                                                                                                                                                                                                                                                                              • 
+            
                                                                                                                                                                                                                                                                            • 
+              If you've changed the project wide settings, make sure the same
+              were applied to each of the targets your app has.
+            
                                                                                                                                                                                                                                                                              • 
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            If you use a value other than
+            $(PRODUCT_BUNDLE_IDENTIFIER) in the
+            CFBundleURLSchemes field of the
+            Info.plist you will also need to pass it as the
+            customScheme option parameter of the
+            authorize and clearSession methods.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > For more info please read the
+            React Native docs.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            > :warning: This SDK is not compatible with "Expo Go"
+            app because of custom native code. It is compatible with Custom Dev
+            Client and EAS builds
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            To use the SDK with Expo, configure the app at build time by
+            providing the domain and the
+            customScheme values through the
+            Config Plugin. To do this, add the following snippet to app.json or
+            app.config.js:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            {
                                                                                                                                                                                                                                                                              "expo": {
                                                                                                                                                                                                                                                                                ...
                                                                                                                                                                                                                                                                                "plugins": [
                                                                                                                                                                                                                                                                                  [
                                                                                                                                                                                                                                                                                    "react-native-auth0",
                                                                                                                                                                                                                                                                                    {
                                                                                                                                                                                                                                                                                      "domain": "YOUR_AUTH0_DOMAIN",
                                                                                                                                                                                                                                                                                      "customScheme": "YOUR_CUSTOM_SCHEME"
                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                  ]
                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                            }
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            > :info: If you want to switch between multiple domains in your app, refer here
                                                                                                                                                                                                                                                                            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
                                                                                                                                                                                                                                                                            APIDescription
                                                                                                                                                                                                                                                                            domainMandatory: Provide the Auth0 domain that can be found at the Application Settings
                                                                                                                                                                                                                                                                            customSchemeOptional: Custom scheme to build the callback URL with. The value provided here should be passed to the customScheme option parameter of the authorize and clearSession methods. The custom scheme should be a unique, all lowercase value with no special characters.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Now you can run the application using expo run:android or expo run:ios.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Callback URLs are the URLs that Auth0 invokes after the authentication process. Auth0 routes your application back to this URL and appends additional parameters to it, including a token. Since callback URLs can be manipulated, you will need to add this URL to your Application's Allowed Callback URLs for security. This will enable Auth0 to recognize these URLs as valid. If omitted, authentication will not be successful.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            On the Android platform this URL is case-sensitive. Because of that, this SDK will auto convert the Bundle Identifier (iOS) and Application ID (Android) values to lowercase in order to build the Callback URL with them. If any of these values contains uppercase characters a warning message will be printed in the console. Make sure to check that the right Callback URL is whitelisted in the Auth0 dashboard or the browser will not route successfully back to your application.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Go to the Auth0 Dashboard, select your application and make sure that Allowed Callback URLs contains the URLs defined below.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            If in addition you plan to use the log out method, you must also add these URLs to the Allowed Logout URLs.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > [!NOTE]
-> Whenever possible, Auth0 recommends using Android App Links and Apple Universal Links for your callback and logout URLs. Custom URL schemes can be subject to client impersonation attacks.
->
-> 💡 If your Android app is using product flavors, you might need to specify different manifest placeholders for each flavor.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            {YOUR_APP_PACKAGE_NAME}.auth0://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+          
                                                                                                                                                                                                                                                                            
+            > :info: If you want to switch between multiple domains in your
+            app, refer
+            here
+          
                                                                                                                                                                                                                                                                            
+          
+            
+              
+                
+                
+              
+            
+            
+              
+                
+                
+              
+              
+                
+                
+              
+            
+          
                                                                                                                                                                                                                                                                            APIDescription
                                                                                                                                                                                                                                                                            domain
+                  Mandatory: Provide the Auth0 domain that can be found at the
+                  Application Settings
+                
                                                                                                                                                                                                                                                                            customScheme
+                  Optional: Custom scheme to build the callback URL with. The
+                  value provided here should be passed to the
+                  customScheme option parameter of the
+                  authorize and clearSession methods.
+                  The custom scheme should be a unique, all lowercase value with
+                  no special characters.
+                
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Now you can run the application using
+            expo run:android or expo run:ios.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            Callback URLs are the URLs that Auth0 invokes after the
+            authentication process. Auth0 routes your application back to this
+            URL and appends additional parameters to it, including a token.
+            Since callback URLs can be manipulated, you will need to add this
+            URL to your Application's Allowed Callback URLs for
+            security. This will enable Auth0 to recognize these URLs as valid.
+            If omitted, authentication will not be successful.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            On the Android platform this URL is case-sensitive. Because of that,
+            this SDK will auto convert the Bundle Identifier (iOS) and
+            Application ID (Android) values to lowercase in order to build the
+            Callback URL with them. If any of these values contains uppercase
+            characters a warning message will be printed in the console. Make
+            sure to check that the right Callback URL is whitelisted in the
+            Auth0 dashboard or the browser will not route successfully back to
+            your application.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Go to the
+            Auth0 Dashboard, select your application and make sure that
+            Allowed Callback URLs contains the URLs defined
+            below.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            If in addition you plan to use the log out method, you must also add
+            these URLs to the Allowed Logout URLs.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > [!NOTE] > Whenever possible, Auth0 recommends using
+            Android App Links
+            and
+            Apple Universal Links
+            for your callback and logout URLs. Custom URL schemes can be subject
+            to
+            client impersonation attacks. > > 💡 If your Android app is using
+            product flavors, you might need to specify different manifest placeholders for
+            each flavor.
+          
                                                                                                                                                                                                                                                                            
+          
+          
+          
                                                                                                                                                                                                                                                                            {YOUR_APP_PACKAGE_NAME}.auth0://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            https://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
+          
+          
                                                                                                                                                                                                                                                                            https://{YOUR_AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            > Replace {YOUR_APP_PACKAGE_NAME} and {YOUR_AUTH0_DOMAIN} with your actual application package name and Auth0 domain. Ensure that {YOUR_APP_PACKAGE_NAME} is all lowercase.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            To enable App Links, set the auth0Scheme to https in your build.gradle file.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            android {
+          
                                                                                                                                                                                                                                                                            
+            > Replace {YOUR_APP_PACKAGE_NAME} and {YOUR_AUTH0_DOMAIN} with
+            your actual application package name and Auth0 domain. Ensure that
+            {YOUR_APP_PACKAGE_NAME} is all lowercase.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            To enable App Links, set the auth0Scheme to
+            https in your build.gradle file.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            android {
     defaultConfig {
         manifestPlaceholders = [auth0Domain: "@string/com_auth0_domain", auth0Scheme: "https"]
     }
 }
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            This configuration ensures that your app uses https for the callback URL scheme, which is required for Android App Links.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Android App Links allow an application to designate itself as the default handler of a given type of link. For example, clicking a URL in an email would open the link in the designated application. This guide will show you how to enable Android App links support for your Auth0-registered application using Auth0's Dashboard.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                              
-
                                                                                                                                                                                                                                                                            1. 
-
                                                                                                                                                                                                                                                                              Go to Auth0 Dashboard > Applications > Applications, and select the name of the application to view.
                                                                                                                                                                                                                                                                              
-
                                                                                                                                                                                                                                                                              2. 
-
                                                                                                                                                                                                                                                                            2. 
-
                                                                                                                                                                                                                                                                              Scroll to the bottom of the Settings page, and select Show Advanced Settings.
                                                                                                                                                                                                                                                                              
-
                                                                                                                                                                                                                                                                              3. 
-
                                                                                                                                                                                                                                                                            3. 
-
                                                                                                                                                                                                                                                                              Select Device Settings, provide the App Package Name and the SHA256 fingerprints of your app’s signing certificate for your Android application, and select Save Changes.
-android-app-link
                                                                                                                                                                                                                                                                              
-
                                                                                                                                                                                                                                                                              4. 
-
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > You can use the following command to generate the fingerprint using the Java keytool in your terminal: keytool -list -v -keystore my-release-key.keystore
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            To learn more about signing certificates, see Android's Sign Your App developer documentation.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
+          
                                                                                                                                                                                                                                                                            
+            This configuration ensures that your app uses https for the callback
+            URL scheme, which is required for Android App Links.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            Android App Links
+            allow an application to designate itself as the default handler of a
+            given type of link. For example, clicking a URL in an email would
+            open the link in the designated application. This guide will show
+            you how to enable Android App links support for your
+            Auth0-registered application using Auth0's Dashboard.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                                                            1. 
+              
                                                                                                                                                                                                                                                                              
+                Go to
+                Auth0 Dashboard > Applications > Applications, and select the name of the application to view.
+              
                                                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                                                              2. 
+            
                                                                                                                                                                                                                                                                            2. 
+              
                                                                                                                                                                                                                                                                              
+                Scroll to the bottom of the Settings page, and select
+                Show Advanced Settings.
+              
                                                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                                                              3. 
+            
                                                                                                                                                                                                                                                                            3. 
+              
                                                                                                                                                                                                                                                                              
+                Select Device Settings, provide the
+                App Package Name and
+                the SHA256 fingerprints of your app’s signing certificate for
+                your Android application, and select Save Changes.
+                android-app-link
+              
                                                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                                                              4. 
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > You can use the following command to generate the fingerprint
+            using the Java keytool in your terminal:
+            keytool -list -v -keystore my-release-key.keystore
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            To learn more about signing certificates, see Android's
+            Sign Your App
+            developer documentation.
+          
                                                                                                                                                                                                                                                                            
+          
+          
+          
                                                                                                                                                                                                                                                                            {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            https://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
+          
+          
                                                                                                                                                                                                                                                                            https://{YOUR_AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            > Replace {PRODUCT_BUNDLE_IDENTIFIER} and {YOUR_AUTH0_DOMAIN} with your actual product bundle identifier and Auth0 domain. Ensure that {PRODUCT_BUNDLE_IDENTIFIER} is all lowercase.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > [!IMPORTANT]
-> This step requires a paid Apple Developer account. It is needed to use Universal Links as callback and logout URLs.
-> Skip this step to use a custom URL scheme instead.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Scroll to the end of the settings page of your Auth0 application and open Advanced Settings > Device Settings. In the iOS section, set Team ID to your Apple Team ID, and App ID to your app's bundle identifier.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Screenshot of the iOS section inside the Auth0 application settings page
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            This will add your app to your Auth0 tenant's apple-app-site-association file.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            In Xcode, go to the Signing and Capabilities tab of your app's target settings, and press the + Capability button. Then select Associated Domains.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Screenshot of the capabilities library inside Xcode
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Next, add the following entry under Associated Domains:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            webcredentials:YOUR_AUTH0_DOMAIN
+          
                                                                                                                                                                                                                                                                            
+            > Replace {PRODUCT_BUNDLE_IDENTIFIER} and
+            {YOUR_AUTH0_DOMAIN} with your actual product bundle
+            identifier and Auth0 domain. Ensure that {PRODUCT_BUNDLE_IDENTIFIER}
+            is all lowercase.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            > [!IMPORTANT] > This step requires a paid Apple Developer
+            account. It is needed to use Universal Links as callback and logout
+            URLs. > Skip this step to use a custom URL scheme instead.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            Scroll to the end of the settings page of your Auth0 application and
+            open Advanced Settings > Device Settings. In the
+            iOS section, set Team ID to your
+            Apple Team ID, and App ID to your app's bundle identifier.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Screenshot of the iOS section inside the Auth0 application settings page
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            This will add your app to your Auth0 tenant's
+            apple-app-site-association file.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            In Xcode, go to the Signing and Capabilities
+            tab
+            of your app's target settings, and press the
+            + Capability button. Then select
+            Associated Domains.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Screenshot of the capabilities library inside Xcode
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Next, add the following
+            entry
+            under Associated Domains:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            webcredentials:YOUR_AUTH0_DOMAIN
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            <details>
-<summary>Example</summary>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            If your Auth0 Domain were example.us.auth0.com, then this value would be:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            webcredentials:example.us.auth0.com
+          
                                                                                                                                                                                                                                                                            <details> <summary>Example</summary>
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            If your Auth0 Domain were example.us.auth0.com, then
+            this value would be:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            webcredentials:example.us.auth0.com
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            If you have a custom domain, replace YOUR_AUTH0_DOMAIN with your custom domain.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > [!NOTE]
-> For the associated domain to work, your app must be signed with your team certificate even when building for the iOS simulator. Make sure you are using the Apple Team whose Team ID is configured in the settings page of your Auth0 application.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Refer to the example of Using custom scheme for web authentication redirection
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > This SDK is OIDC compliant. To ensure OIDC compliant responses from the Auth0 servers enable the OIDC Conformant switch in your Auth0 dashboard under Application / Settings / Advanced OAuth. For more information please check this documentation.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            The SDK exports a React hook as the primary interface for performing web authentication through the browser using Auth0 Universal Login.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Use the methods from the useAuth0 hook to implement login, logout, and to retrieve details about the authenticated user.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            See the API Documentation for full details on the useAuth0 hook.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            First, import the Auth0Provider component and wrap it around your application. Provide the domain and clientId values as given to you when setting up your Auth0 app in the dashboard:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            import { Auth0Provider } from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const App = () =&gt; {
                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"&gt;
                                                                                                                                                                                                                                                                                  {/* YOUR APP */}
                                                                                                                                                                                                                                                                                &lt;/Auth0Provider&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            export default App;
+          
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            If you have a custom domain, replace YOUR_AUTH0_DOMAIN with your custom domain.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > [!NOTE] > For the associated domain to work, your app must
+            be signed with your team certificate
+            even when building for the iOS simulator. Make sure
+            you are using the Apple Team whose Team ID is configured in the
+            settings page of your Auth0 application.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Refer to the example of
+            Using custom scheme for web authentication redirection
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            > This SDK is OIDC compliant. To ensure OIDC compliant responses
+            from the Auth0 servers enable the
+            OIDC Conformant switch in your Auth0 dashboard
+            under Application / Settings / Advanced OAuth. For more
+            information please check
+            this documentation.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            The SDK exports a React hook as the primary interface for performing
+            web authentication through the
+            browser using Auth0
+            Universal Login.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Use the methods from the useAuth0 hook to implement
+            login, logout, and to retrieve details about the authenticated user.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            See the
+            API Documentation
+            for full details on the useAuth0 hook.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            First, import the Auth0Provider component and wrap it
+            around your application. Provide the domain and
+            clientId values as given to you when setting up your
+            Auth0 app in the dashboard:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            import { Auth0Provider } from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const App = () =&gt; {
                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;Auth0Provider domain="YOUR_AUTH0_DOMAIN" clientId="YOUR_AUTH0_CLIENT_ID"&gt;
                                                                                                                                                                                                                                                                                  {/* YOUR APP */}
                                                                                                                                                                                                                                                                                &lt;/Auth0Provider&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            export default App;
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            You can also pass custom headers that will be included in all API requests:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            import { Auth0Provider } from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const App = () =&gt; {
                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;Auth0Provider 
                                                                                                                                                                                                                                                                                  domain="YOUR_AUTH0_DOMAIN" 
                                                                                                                                                                                                                                                                                  clientId="YOUR_AUTH0_CLIENT_ID"
                                                                                                                                                                                                                                                                                  headers={{ 'X-Custom-Header': 'custom-value' }}
                                                                                                                                                                                                                                                                                &gt;
                                                                                                                                                                                                                                                                                  {/* YOUR APP */}
                                                                                                                                                                                                                                                                                &lt;/Auth0Provider&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            export default App;
+          
                                                                                                                                                                                                                                                                            
+            You can also pass custom headers that will be included in all API
+            requests:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            import { Auth0Provider } from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const App = () =&gt; {
                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;Auth0Provider 
                                                                                                                                                                                                                                                                                  domain="YOUR_AUTH0_DOMAIN" 
                                                                                                                                                                                                                                                                                  clientId="YOUR_AUTH0_CLIENT_ID"
                                                                                                                                                                                                                                                                                  headers={{ 'X-Custom-Header': 'custom-value' }}
                                                                                                                                                                                                                                                                                &gt;
                                                                                                                                                                                                                                                                                  {/* YOUR APP */}
                                                                                                                                                                                                                                                                                &lt;/Auth0Provider&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            export default App;
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            <details>
-<summary>Using the Auth0 class</summary>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            If you're not using React Hooks, you can simply instantiate the Auth0 class:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            import Auth0 from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const auth0 = new Auth0({
                                                                                                                                                                                                                                                                              domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                                                                                                                              clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                                                                                                                            });
+          
                                                                                                                                                                                                                                                                            
+            <details> <summary>Using the
+            Auth0 class</summary>
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            If you're not using React Hooks, you can simply instantiate the
+            Auth0 class:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            import Auth0 from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const auth0 = new Auth0({
                                                                                                                                                                                                                                                                              domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                                                                                                                              clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                                                                                                                            });
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            You can also pass custom headers that will be included in all API requests:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            import Auth0 from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const auth0 = new Auth0({
                                                                                                                                                                                                                                                                              domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                                                                                                                              clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                                                                                                                              headers: {
                                                                                                                                                                                                                                                                                'X-Custom-Header': 'custom-value',
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                            });
+          
                                                                                                                                                                                                                                                                            
+            You can also pass custom headers that will be included in all API
+            requests:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            import Auth0 from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const auth0 = new Auth0({
                                                                                                                                                                                                                                                                              domain: 'YOUR_AUTH0_DOMAIN',
                                                                                                                                                                                                                                                                              clientId: 'YOUR_AUTH0_CLIENT_ID',
                                                                                                                                                                                                                                                                              headers: {
                                                                                                                                                                                                                                                                                'X-Custom-Header': 'custom-value',
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                            });
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Then import the hook into a component where you want to get access to the properties and methods for integrating with Auth0:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            import { useAuth0 } from 'react-native-auth0';
+          
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Then import the hook into a component where you want to get access
+            to the properties and methods for integrating with Auth0:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            import { useAuth0 } from 'react-native-auth0';
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            Use the authorize method to redirect the user to the Auth0 Universal Login page for authentication. If scope is not specified, openid profile email is used by default.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                              
-
                                                                                                                                                                                                                                                                            • The isLoading property is set to true once the authentication state of the user is known to the SDK.
                                                                                                                                                                                                                                                                              • 
-
                                                                                                                                                                                                                                                                            • The user property is populated with details about the authenticated user. If user is null, no user is currently authenticated.
                                                                                                                                                                                                                                                                              • 
-
                                                                                                                                                                                                                                                                            • The error property is populated if any error occurs.
                                                                                                                                                                                                                                                                              • 
-
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            const Component = () =&gt; {
                                                                                                                                                                                                                                                                              const { authorize, user, isLoading, error } = useAuth0();

                                                                                                                                                                                                                                                                              const login = async () =&gt; {
                                                                                                                                                                                                                                                                                await authorize();
                                                                                                                                                                                                                                                                              };

                                                                                                                                                                                                                                                                              if (isLoading) {
                                                                                                                                                                                                                                                                                return (
                                                                                                                                                                                                                                                                                  &lt;View&gt;
                                                                                                                                                                                                                                                                                    &lt;Text&gt;SDK is Loading&lt;/Text&gt;
                                                                                                                                                                                                                                                                                  &lt;/View&gt;
                                                                                                                                                                                                                                                                                );
                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;View&gt;
                                                                                                                                                                                                                                                                                  {!user && &lt;Button onPress={login} title="Log in" /&gt;}
                                                                                                                                                                                                                                                                                  {user && &lt;Text&gt;Logged in as {user.name}&lt;/Text&gt;}
                                                                                                                                                                                                                                                                                  {error && &lt;Text&gt;{error.message}&lt;/Text&gt;}
                                                                                                                                                                                                                                                                                &lt;/View&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };
+          
+          
                                                                                                                                                                                                                                                                            
+            Use the authorize method to redirect the user to the
+            Auth0
+            Universal Login
+            page for authentication. If scope is not specified,
+            openid profile email is used by default.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                              
+            
                                                                                                                                                                                                                                                                            • 
+              The isLoading property is set to true once the
+              authentication state of the user is known to the SDK.
+            
                                                                                                                                                                                                                                                                              • 
+            
                                                                                                                                                                                                                                                                            • 
+              The user property is populated with details about the
+              authenticated user. If user is null, no
+              user is currently authenticated.
+            
                                                                                                                                                                                                                                                                              • 
+            
                                                                                                                                                                                                                                                                            • 
+              The error property is populated if any error occurs.
+            
                                                                                                                                                                                                                                                                              • 
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            const Component = () =&gt; {
                                                                                                                                                                                                                                                                              const { authorize, user, isLoading, error } = useAuth0();

                                                                                                                                                                                                                                                                              const login = async () =&gt; {
                                                                                                                                                                                                                                                                                await authorize();
                                                                                                                                                                                                                                                                              };

                                                                                                                                                                                                                                                                              if (isLoading) {
                                                                                                                                                                                                                                                                                return (
                                                                                                                                                                                                                                                                                  &lt;View&gt;
                                                                                                                                                                                                                                                                                    &lt;Text&gt;SDK is Loading&lt;/Text&gt;
                                                                                                                                                                                                                                                                                  &lt;/View&gt;
                                                                                                                                                                                                                                                                                );
                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;View&gt;
                                                                                                                                                                                                                                                                                  {!user && &lt;Button onPress={login} title="Log in" /&gt;}
                                                                                                                                                                                                                                                                                  {user && &lt;Text&gt;Logged in as {user.name}&lt;/Text&gt;}
                                                                                                                                                                                                                                                                                  {error && &lt;Text&gt;{error.message}&lt;/Text&gt;}
                                                                                                                                                                                                                                                                                &lt;/View&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            <details>
-<summary>Using the Auth0 class</summary>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            auth0.webAuth
                                                                                                                                                                                                                                                                              .authorize()
                                                                                                                                                                                                                                                                              .then(credentials =&gt; console.log(credentials))
                                                                                                                                                                                                                                                                              .catch(error =&gt; console.log(error));
+          
                                                                                                                                                                                                                                                                            
+            <details> <summary>Using the
+            Auth0 class</summary>
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            auth0.webAuth
                                                                                                                                                                                                                                                                              .authorize()
                                                                                                                                                                                                                                                                              .then(credentials =&gt; console.log(credentials))
                                                                                                                                                                                                                                                                              .catch(error =&gt; console.log(error));
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > Web Authentication flows require a Browser application installed on the device. When no Browser is available, an error of type a0.browser_not_available will be raised via the provided callback.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            ios-sso-alert
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Check the FAQ for more information about the alert box that pops up by default when using Web Auth on iOS.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > See also this blog post for a detailed overview of Single Sign-On (SSO) on iOS.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Log the user out by using the clearSession method from the useAuth0 hook.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            const Component = () =&gt; {
                                                                                                                                                                                                                                                                              const { clearSession, user } = useAuth0();

                                                                                                                                                                                                                                                                              const logout = async () =&gt; {
                                                                                                                                                                                                                                                                                await clearSession();
                                                                                                                                                                                                                                                                              };

                                                                                                                                                                                                                                                                              return &lt;View&gt;{user && &lt;Button onPress={logout} title="Log out" /&gt;}&lt;/View&gt;;
                                                                                                                                                                                                                                                                            };
+          
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > Web Authentication flows require a Browser application
+            installed on the device. When no Browser is available, an error of
+            type a0.browser_not_available will be raised via the
+            provided callback.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            ios-sso-alert
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Check the FAQ for more information about
+            the alert box that pops up by default when using
+            Web Auth on iOS.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > See also
+            this blog post
+            for a detailed overview of Single Sign-On (SSO) on iOS.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            Log the user out by using the clearSession method from
+            the useAuth0 hook.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            const Component = () =&gt; {
                                                                                                                                                                                                                                                                              const { clearSession, user } = useAuth0();

                                                                                                                                                                                                                                                                              const logout = async () =&gt; {
                                                                                                                                                                                                                                                                                await clearSession();
                                                                                                                                                                                                                                                                              };

                                                                                                                                                                                                                                                                              return &lt;View&gt;{user && &lt;Button onPress={logout} title="Log out" /&gt;}&lt;/View&gt;;
                                                                                                                                                                                                                                                                            };
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            <details>
-<summary>Using the Auth0 class</summary>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            auth0.webAuth.clearSession().catch((error) =&gt; console.log(error));
+          
                                                                                                                                                                                                                                                                            
+            <details> <summary>Using the
+            Auth0 class</summary>
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            auth0.webAuth.clearSession().catch((error) =&gt; console.log(error));
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
-
-
                                                                                                                                                                                                                                                                            The Credentials Manager allows you to securely store and retrieve the user's credentials. The credentials will be stored encrypted in Shared Preferences on Android, and in the Keychain on iOS.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            The Auth0 class exposes the credentialsManager property for you to interact with using the API below.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > 💡 If you're using Web Auth (authorize) through Hooks, you do not need to manually store the credentials after login and delete them after logout; the SDK does this automatically.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            When the users open your app, check for valid credentials. If they exist, you can retrieve them and redirect the users to the app's main flow without any additional login steps.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();

                                                                                                                                                                                                                                                                            if (isLoggedIn) {
                                                                                                                                                                                                                                                                              // Retrieve credentials and redirect to the main flow
                                                                                                                                                                                                                                                                            } else {
                                                                                                                                                                                                                                                                              // Redirect to the login page
                                                                                                                                                                                                                                                                            }
+          
                                                                                                                                                                                                                                                                            </details>
                                                                                                                                                                                                                                                                            
+          
+          
+          
                                                                                                                                                                                                                                                                            
+            The Credentials Manager allows you to securely store and retrieve
+            the user's credentials. The credentials will be stored encrypted in
+            Shared Preferences on Android, and in the Keychain on iOS.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            The Auth0 class exposes the
+            credentialsManager property for you to interact with
+            using the API below.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > 💡 If you're using Web Auth (authorize) through
+            Hooks, you do not need to manually store the credentials after login
+            and delete them after logout; the SDK does this automatically.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            When the users open your app, check for valid credentials. If they
+            exist, you can retrieve them and redirect the users to the app's
+            main flow without any additional login steps.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            const isLoggedIn = await auth0.credentialsManager.hasValidCredentials();

                                                                                                                                                                                                                                                                            if (isLoggedIn) {
                                                                                                                                                                                                                                                                              // Retrieve credentials and redirect to the main flow
                                                                                                                                                                                                                                                                            } else {
                                                                                                                                                                                                                                                                              // Redirect to the login page
                                                                                                                                                                                                                                                                            }
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            The credentials will be automatically renewed using the refresh token, if the access token has expired. This method is thread safe.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            const credentials = await auth0.credentialsManager.getCredentials();
+          
+          
                                                                                                                                                                                                                                                                            
+            The credentials will be automatically renewed using the
+            refresh token, if the access token has expired.
+            This method is thread safe.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            const credentials = await auth0.credentialsManager.getCredentials();
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            > 💡 You do not need to call credentialsManager.saveCredentials() afterward. The Credentials Manager automatically persists the renewed credentials.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > :warning: The requireLocalAuthentication method is no longer available as part of the CredentialsManager class or the useAuth0 Hook from v4 of the SDK.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > ℹ️ You need to use at least version 0.59.0 of React Native, as it uses FragmentActivity as the base activity, which is required for biometric authentication to work.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            You can enable an additional level of user authentication before retrieving credentials using the local authentication supported by the device, for example PIN or fingerprint on Android, and Face ID or Touch ID on iOS.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Refer to the instructions below to understand how to enable authentication before retrieving credentials based on your setup:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Using Auth0 Class:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            The Auth0 class constructor now accepts a new parameter, which is an instance of the LocalAuthenticationOptions object. This needs to be passed while creating an instance of Auth0 to enable authentication before obtaining credentials, as shown in the code snippet below:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            import Auth0 from 'react-native-auth0';
                                                                                                                                                                                                                                                                            const localAuthOptions: LocalAuthenticationOptions = {
                                                                                                                                                                                                                                                                              title: 'Authenticate to retreive your credentials',
                                                                                                                                                                                                                                                                              subtitle: 'Please authenticate to continue',
                                                                                                                                                                                                                                                                              description: 'We need to authenticate you to retrieve your credentials',
                                                                                                                                                                                                                                                                              cancelTitle: 'Cancel',
                                                                                                                                                                                                                                                                              evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                                                                                                                                                                                                                                              fallbackTitle: 'Use Passcode',
                                                                                                                                                                                                                                                                              authenticationLevel: LocalAuthenticationLevel.strong,
                                                                                                                                                                                                                                                                              deviceCredentialFallback: true,
                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                            const auth0 = new Auth0({
                                                                                                                                                                                                                                                                              domain: config.domain,
                                                                                                                                                                                                                                                                              clientId: config.clientId,
                                                                                                                                                                                                                                                                              localAuthenticationOptions: localAuthOptions,
                                                                                                                                                                                                                                                                            });
+          
                                                                                                                                                                                                                                                                            
+            > 💡 You do not need to call credentialsManager.saveCredentials()
+            afterward. The Credentials Manager automatically persists the
+            renewed credentials.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            > :warning: The requireLocalAuthentication method is
+            no longer available as part of the
+            CredentialsManager class or the
+            useAuth0 Hook from v4 of the SDK.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > ℹ️ You need to use at least version 0.59.0 of
+            React Native, as it uses FragmentActivity as the base
+            activity, which is required for biometric authentication to work.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            You can enable an additional level of user authentication before
+            retrieving credentials using the local authentication supported by
+            the device, for example PIN or fingerprint on Android, and Face ID
+            or Touch ID on iOS.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Refer to the instructions below to understand how to enable
+            authentication before retrieving credentials based on your setup:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            Using Auth0 Class:
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            The Auth0 class constructor now accepts a new
+            parameter, which is an instance of the
+            LocalAuthenticationOptions object. This needs to be
+            passed while creating an instance of Auth0 to enable
+            authentication before obtaining credentials, as shown in the code
+            snippet below:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            import Auth0 from 'react-native-auth0';
                                                                                                                                                                                                                                                                            const localAuthOptions: LocalAuthenticationOptions = {
                                                                                                                                                                                                                                                                              title: 'Authenticate to retreive your credentials',
                                                                                                                                                                                                                                                                              subtitle: 'Please authenticate to continue',
                                                                                                                                                                                                                                                                              description: 'We need to authenticate you to retrieve your credentials',
                                                                                                                                                                                                                                                                              cancelTitle: 'Cancel',
                                                                                                                                                                                                                                                                              evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                                                                                                                                                                                                                                              fallbackTitle: 'Use Passcode',
                                                                                                                                                                                                                                                                              authenticationLevel: LocalAuthenticationLevel.strong,
                                                                                                                                                                                                                                                                              deviceCredentialFallback: true,
                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                            const auth0 = new Auth0({
                                                                                                                                                                                                                                                                              domain: config.domain,
                                                                                                                                                                                                                                                                              clientId: config.clientId,
                                                                                                                                                                                                                                                                              localAuthenticationOptions: localAuthOptions,
                                                                                                                                                                                                                                                                            });
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            Using Hooks (Auth0Provider):
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Auth0Provider now accepts a new parameter, which is an instance of the LocalAuthenticationOptions object. This needs to be passed to enable authentication before obtaining credentials, as shown in the code snippet below:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            import { Auth0Provider } from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const localAuthOptions: LocalAuthenticationOptions = {
                                                                                                                                                                                                                                                                              title: 'Authenticate to retreive your credentials',
                                                                                                                                                                                                                                                                              subtitle: 'Please authenticate to continue',
                                                                                                                                                                                                                                                                              description: 'We need to authenticate you to retrieve your credentials',
                                                                                                                                                                                                                                                                              cancelTitle: 'Cancel',
                                                                                                                                                                                                                                                                              evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                                                                                                                                                                                                                                              fallbackTitle: 'Use Passcode',
                                                                                                                                                                                                                                                                              authenticationLevel: LocalAuthenticationLevel.strong,
                                                                                                                                                                                                                                                                              deviceCredentialFallback: true,
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            const App = () =&gt; {
                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;Auth0Provider
                                                                                                                                                                                                                                                                                  domain={config.domain}
                                                                                                                                                                                                                                                                                  clientId={config.clientId}
                                                                                                                                                                                                                                                                                  localAuthenticationOptions={localAuthOptions}
                                                                                                                                                                                                                                                                                &gt;
                                                                                                                                                                                                                                                                                  {/* YOUR APP */}
                                                                                                                                                                                                                                                                                &lt;/Auth0Provider&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            export default App;
+          
                                                                                                                                                                                                                                                                            Using Hooks (Auth0Provider):
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Auth0Provider now accepts a new parameter, which is an
+            instance of the LocalAuthenticationOptions object. This
+            needs to be passed to enable authentication before obtaining
+            credentials, as shown in the code snippet below:
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            import { Auth0Provider } from 'react-native-auth0';

                                                                                                                                                                                                                                                                            const localAuthOptions: LocalAuthenticationOptions = {
                                                                                                                                                                                                                                                                              title: 'Authenticate to retreive your credentials',
                                                                                                                                                                                                                                                                              subtitle: 'Please authenticate to continue',
                                                                                                                                                                                                                                                                              description: 'We need to authenticate you to retrieve your credentials',
                                                                                                                                                                                                                                                                              cancelTitle: 'Cancel',
                                                                                                                                                                                                                                                                              evaluationPolicy: LocalAuthenticationStrategy.deviceOwnerWithBiometrics,
                                                                                                                                                                                                                                                                              fallbackTitle: 'Use Passcode',
                                                                                                                                                                                                                                                                              authenticationLevel: LocalAuthenticationLevel.strong,
                                                                                                                                                                                                                                                                              deviceCredentialFallback: true,
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            const App = () =&gt; {
                                                                                                                                                                                                                                                                              return (
                                                                                                                                                                                                                                                                                &lt;Auth0Provider
                                                                                                                                                                                                                                                                                  domain={config.domain}
                                                                                                                                                                                                                                                                                  clientId={config.clientId}
                                                                                                                                                                                                                                                                                  localAuthenticationOptions={localAuthOptions}
                                                                                                                                                                                                                                                                                &gt;
                                                                                                                                                                                                                                                                                  {/* YOUR APP */}
                                                                                                                                                                                                                                                                                &lt;/Auth0Provider&gt;
                                                                                                                                                                                                                                                                              );
                                                                                                                                                                                                                                                                            };

                                                                                                                                                                                                                                                                            export default App;
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            Detailed information on LocalAuthenticationOptions is available here
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            LocalAuthenticationOptions:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            The options for configuring the display of local authentication prompt, authentication level (Android only), and evaluation policy (iOS only).
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Properties:
                                                                                                                                                                                                                                                                            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
                                                                                                                                                                                                                                                                            PropertyTypeDescriptionApplicable Platforms
                                                                                                                                                                                                                                                                            titleStringThe title of the authentication prompt.Android, iOS
                                                                                                                                                                                                                                                                            subtitleString (optional)The subtitle of the authentication prompt.Android
                                                                                                                                                                                                                                                                            descriptionString (optional)The description of the authentication prompt.Android
                                                                                                                                                                                                                                                                            cancelTitleString (optional)The cancel button title of the authentication prompt.Android, iOS
                                                                                                                                                                                                                                                                            evaluationPolicyLocalAuthenticationStrategy (optional)The evaluation policy to use when prompting the user for authentication. Defaults to deviceOwnerWithBiometrics.iOS
                                                                                                                                                                                                                                                                            fallbackTitleString (optional)The fallback button title of the authentication prompt.iOS
                                                                                                                                                                                                                                                                            authenticationLevelLocalAuthenticationLevel (optional)The authentication level to use when prompting the user for authentication. Defaults to strong.Android
                                                                                                                                                                                                                                                                            deviceCredentialFallbackBoolean (optional)Should the user be given the option to authenticate with their device PIN, pattern, or password instead of a biometric. Defaults to falseAndroid
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            > :warning: You need a real device to test Local Authentication for iOS. Local Authentication is not available in simulators.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            The Credentials Manager will only throw CredentialsManagerError exceptions. You can find more information in the details property of the exception.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            try {
                                                                                                                                                                                                                                                                              const credentials = await auth0.credentialsManager.getCredentials();
                                                                                                                                                                                                                                                                            } catch (error) {
                                                                                                                                                                                                                                                                              console.log(error);
                                                                                                                                                                                                                                                                            }
+          
                                                                                                                                                                                                                                                                            
+            Detailed information on LocalAuthenticationOptions is
+            available here
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            LocalAuthenticationOptions:
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            The options for configuring the display of local authentication
+            prompt, authentication level (Android only), and evaluation policy
+            (iOS only).
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            Properties:
                                                                                                                                                                                                                                                                            
+          
+            
+              
+                
+                
+                
+                
+              
+            
+            
+              
+                
+                
+                
+                
+              
+              
+                
+                
+                
+                
+              
+              
+                
+                
+                
+                
+              
+              
+                
+                
+                
+                
+              
+              
+                
+                
+                
+                
+              
+              
+                
+                
+                
+                
+              
+              
+                
+                
+                
+                
+              
+              
+                
+                
+                
+                
+              
+            
+          
                                                                                                                                                                                                                                                                            PropertyTypeDescriptionApplicable Platforms
                                                                                                                                                                                                                                                                            titleStringThe title of the authentication prompt.Android, iOS
                                                                                                                                                                                                                                                                            subtitleString (optional)The subtitle of the authentication prompt.Android
                                                                                                                                                                                                                                                                            descriptionString (optional)The description of the authentication prompt.Android
                                                                                                                                                                                                                                                                            cancelTitleString (optional)The cancel button title of the authentication prompt.Android, iOS
                                                                                                                                                                                                                                                                            evaluationPolicyLocalAuthenticationStrategy (optional)
+                  The evaluation policy to use when prompting the user for
+                  authentication. Defaults to
+                  deviceOwnerWithBiometrics.
+                iOS
                                                                                                                                                                                                                                                                            fallbackTitleString (optional)The fallback button title of the authentication prompt.iOS
                                                                                                                                                                                                                                                                            authenticationLevelLocalAuthenticationLevel (optional)
+                  The authentication level to use when prompting the user for
+                  authentication. Defaults to strong.
+                Android
                                                                                                                                                                                                                                                                            deviceCredentialFallbackBoolean (optional)
+                  Should the user be given the option to authenticate with their
+                  device PIN, pattern, or password instead of a biometric.
+                  Defaults to false
+                Android
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            > :warning: You need a real device to test Local Authentication
+            for iOS. Local Authentication is not available in simulators.
+          
                                                                                                                                                                                                                                                                            
+          
+          
                                                                                                                                                                                                                                                                            
+            The Credentials Manager will only throw
+            CredentialsManagerError exceptions. You can find more
+            information in the details property of the exception.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            try {
                                                                                                                                                                                                                                                                              const credentials = await auth0.credentialsManager.getCredentials();
                                                                                                                                                                                                                                                                            } catch (error) {
                                                                                                                                                                                                                                                                              console.log(error);
                                                                                                                                                                                                                                                                            }
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            Platform agnostic errors:
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            You can access the platform agnostic generic error codes as below :
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            try {
                                                                                                                                                                                                                                                                              const credentials = await auth0.credentialsManager.getCredentials();
                                                                                                                                                                                                                                                                            } catch (error) {
                                                                                                                                                                                                                                                                              console.log(e.type);
                                                                                                                                                                                                                                                                            }
+          
                                                                                                                                                                                                                                                                            Platform agnostic errors:
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            You can access the platform agnostic generic error codes as below :
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            try {
                                                                                                                                                                                                                                                                              const credentials = await auth0.credentialsManager.getCredentials();
                                                                                                                                                                                                                                                                            } catch (error) {
                                                                                                                                                                                                                                                                              console.log(e.type);
                                                                                                                                                                                                                                                                            }
 
                                                                                                                                                                                                                                                                            
 
-
                                                                                                                                                                                                                                                                            Note : We have platform agnostic error codes available only for CredentialsManagerError as of now.
                                                                                                                                                                                                                                                                            
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
                                                                                                                                                                                                                                                                            Generic Error CodeCorresponding Error Code in AndroidCorresponding Error Code in iOS
                                                                                                                                                                                                                                                                            INVALID_CREDENTIALSINVALID_CREDENTIALS
                                                                                                                                                                                                                                                                            NO_CREDENTIALSNO_CREDENTIALSnoCredentials
                                                                                                                                                                                                                                                                            NO_REFRESH_TOKENNO_REFRESH_TOKENnoRefreshToken
                                                                                                                                                                                                                                                                            RENEW_FAILEDRENEW_FAILEDrenewFailed
                                                                                                                                                                                                                                                                            STORE_FAILEDSTORE_FAILEDstoreFailed
                                                                                                                                                                                                                                                                            REVOKE_FAILEDREVOKE_FAILEDrevokeFailed
                                                                                                                                                                                                                                                                            LARGE_MIN_TTLLARGE_MIN_TTLlargeMinTTL
                                                                                                                                                                                                                                                                            INCOMPATIBLE_DEVICEINCOMPATIBLE_DEVICE
                                                                                                                                                                                                                                                                            CRYPTO_EXCEPTIONCRYPTO_EXCEPTION
                                                                                                                                                                                                                                                                            BIOMETRICS_FAILEDOneOf <br>BIOMETRIC_NO_ACTIVITY,BIOMETRIC_ERROR_STATUS_UNKNOWN,BIOMETRIC_ERROR_UNSUPPORTED,<br>BIOMETRIC_ERROR_HW_UNAVAILABLE,BIOMETRIC_ERROR_NONE_ENROLLED,BIOMETRIC_ERROR_NO_HARDWARE,<br>BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED,BIOMETRIC_AUTHENTICATION_CHECK_FAILED,<br>BIOMETRIC_ERROR_DEVICE_CREDENTIAL_NOT_AVAILABLEbiometricsFailed
                                                                                                                                                                                                                                                                            NO_NETWORKNO_NETWORK
                                                                                                                                                                                                                                                                            API_ERRORAPI_ERROR
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            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.
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            <p align="center">
-<picture>
-<source media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
-<source media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150">
-<img alt="Auth0 Logo" src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150">
-</picture>
-</p>
-<p align="center">Auth0 is an easy to implement, adaptable authentication and authorization platform. To learn more checkout <a href="https://auth0.com/why-auth0">Why Auth0?</a></p>
-<p align="center">
-This project is licensed under the MIT license. See the <a href="https://github.com/auth0/react-native-auth0/blob/master/LICENSE"> LICENSE</a> file for more info.</p>
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            <!-- Variables -->
                                                                                                                                                                                                                                                                            
-
                                                                                                                                                                                                                                                                            Settings
                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                            On This Page
                                                                                                                                                                                                                                                                            DocumentationGetting StartedNext StepsFeedback
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            Note : We have platform agnostic error codes available only
+            for CredentialsManagerError as of now.
+          
                                                                                                                                                                                                                                                                            
+          
+            
+              
+                
+                
+                
+              
+            
+            
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+              
+                
+                
+                
+              
+            
+          
                                                                                                                                                                                                                                                                            Generic Error CodeCorresponding Error Code in AndroidCorresponding Error Code in iOS
                                                                                                                                                                                                                                                                            INVALID_CREDENTIALSINVALID_CREDENTIALS
                                                                                                                                                                                                                                                                            NO_CREDENTIALSNO_CREDENTIALSnoCredentials
                                                                                                                                                                                                                                                                            NO_REFRESH_TOKENNO_REFRESH_TOKENnoRefreshToken
                                                                                                                                                                                                                                                                            RENEW_FAILEDRENEW_FAILEDrenewFailed
                                                                                                                                                                                                                                                                            STORE_FAILEDSTORE_FAILEDstoreFailed
                                                                                                                                                                                                                                                                            REVOKE_FAILEDREVOKE_FAILEDrevokeFailed
                                                                                                                                                                                                                                                                            LARGE_MIN_TTLLARGE_MIN_TTLlargeMinTTL
                                                                                                                                                                                                                                                                            INCOMPATIBLE_DEVICEINCOMPATIBLE_DEVICE
                                                                                                                                                                                                                                                                            CRYPTO_EXCEPTIONCRYPTO_EXCEPTION
                                                                                                                                                                                                                                                                            BIOMETRICS_FAILED
+                  OneOf
+                  <br>BIOMETRIC_NO_ACTIVITY,BIOMETRIC_ERROR_STATUS_UNKNOWN,BIOMETRIC_ERROR_UNSUPPORTED,<br>BIOMETRIC_ERROR_HW_UNAVAILABLE,BIOMETRIC_ERROR_NONE_ENROLLED,BIOMETRIC_ERROR_NO_HARDWARE,<br>BIOMETRIC_ERROR_SECURITY_UPDATE_REQUIRED,BIOMETRIC_AUTHENTICATION_CHECK_FAILED,<br>BIOMETRIC_ERROR_DEVICE_CREDENTIAL_NOT_AVAILABLE
+                biometricsFailed
                                                                                                                                                                                                                                                                            NO_NETWORKNO_NETWORK
                                                                                                                                                                                                                                                                            API_ERRORAPI_ERROR
                                                                                                                                                                                                                                                                            
+          
+          
+          
                                                                                                                                                                                                                                                                            
+            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.
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            
+            <p align="center"> <picture> <source
+            media="(prefers-color-scheme: light)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> <source
+            media="(prefers-color-scheme: dark)" srcset="https://cdn.auth0.com/website/sdks/logos/auth0_dark_mode.png" width="150"> <img alt="Auth0 Logo"
+            src="https://cdn.auth0.com/website/sdks/logos/auth0_light_mode.png" width="150"> </picture> </p> <p
+            align="center">Auth0 is an easy to implement, adaptable
+            authentication and authorization platform. To learn more checkout
+            <a href="https://auth0.com/why-auth0">Why Auth0?</a></p> <p
+            align="center"> This project is licensed under the MIT
+            license. See the <a href="https://github.com/auth0/react-native-auth0/blob/master/LICENSE"> LICENSE</a> file for more info.</p>
+          
                                                                                                                                                                                                                                                                            
+          
                                                                                                                                                                                                                                                                            <!-- Variables -->
                                                                                                                                                                                                                                                                            
+
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                            + + DocumentationGetting Started + + Next Steps + + Feedback + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                            + + diff --git a/docs/interfaces/Auth0Options.html b/docs/interfaces/Auth0Options.html index a9d9e152..9db09789 100644 --- a/docs/interfaces/Auth0Options.html +++ b/docs/interfaces/Auth0Options.html @@ -1,14 +1,665 @@ -Auth0Options | react-native-auth0
                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                              Interface Auth0Options

                                                                                                                                                                                                                                                                              Options for configuring the Auth0 client.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              interface Auth0Options {
                                                                                                                                                                                                                                                                                  clientId: string;
                                                                                                                                                                                                                                                                                  domain: string;
                                                                                                                                                                                                                                                                                  headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                  localAuthenticationOptions?: LocalAuthenticationOptions;
                                                                                                                                                                                                                                                                                  telemetry?: Telemetry;
                                                                                                                                                                                                                                                                                  timeout?: number;
                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              clientId -domain -headers? -localAuthenticationOptions? -telemetry? -timeout? -

                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                              clientId: string

                                                                                                                                                                                                                                                                              The client identifier of your application.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              domain: string

                                                                                                                                                                                                                                                                              The Auth0 domain for your tenant.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              headers?: Record<string, string>

                                                                                                                                                                                                                                                                              (Optional) Custom headers to include in requests.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              localAuthenticationOptions?: LocalAuthenticationOptions

                                                                                                                                                                                                                                                                              Options for configuring local authentication.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              telemetry?: Telemetry

                                                                                                                                                                                                                                                                              Telemetry information to include in requests.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              timeout?: number

                                                                                                                                                                                                                                                                              The timeout in milliseconds for network requests.

                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                              + + + + + + Auth0Options | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                Interface Auth0Options

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Options for configuring the Auth0 client.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + interface + Auth0Options + {
                                                                                                                                                                                                                                                                                    clientId: + string;
                                                                                                                                                                                                                                                                                    domain: + string;
                                                                                                                                                                                                                                                                                    headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                    localAuthenticationOptions?: + LocalAuthenticationOptions;
                                                                                                                                                                                                                                                                                    telemetry?: + Telemetry;
                                                                                                                                                                                                                                                                                    timeout?: + number;
                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + clientId + + domain + + headers? + + localAuthenticationOptions? + + telemetry? + + timeout? +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                + clientId: + string +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                The client identifier of your application.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                + domain: + string +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                The Auth0 domain for your tenant.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                (Optional) Custom headers to include in requests.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                + localAuthenticationOptions?: + LocalAuthenticationOptions +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Options for configuring local authentication.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                + telemetry?: + Telemetry +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Telemetry information to include in requests.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                + timeout?: + number +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                The timeout in milliseconds for network requests.

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                + + diff --git a/docs/interfaces/AuthorizeUrlOptions.html b/docs/interfaces/AuthorizeUrlOptions.html index 6b3c3833..78003a6d 100644 --- a/docs/interfaces/AuthorizeUrlOptions.html +++ b/docs/interfaces/AuthorizeUrlOptions.html @@ -1,9 +1,501 @@ -AuthorizeUrlOptions | react-native-auth0
                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                  Interface AuthorizeUrlOptions

                                                                                                                                                                                                                                                                                  Options for building a URL for /authorize

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  interface AuthorizeUrlOptions {
                                                                                                                                                                                                                                                                                      redirectUri: object;
                                                                                                                                                                                                                                                                                      responseType: string;
                                                                                                                                                                                                                                                                                      state: object;
                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                  • [key: string]: any

                                                                                                                                                                                                                                                                                    Custom parameters to send to /authorize

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  redirectUri -responseType -state -

                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                  redirectUri: object

                                                                                                                                                                                                                                                                                  Where the authorization server will redirect back after success or failure.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  responseType: string

                                                                                                                                                                                                                                                                                  The response_type value

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  state: object

                                                                                                                                                                                                                                                                                  Random string to prevent CSRF attacks.

                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                  + + + + + + AuthorizeUrlOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                    Interface AuthorizeUrlOptions

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Options for building a URL for /authorize

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + interface + AuthorizeUrlOptions + {
                                                                                                                                                                                                                                                                                        redirectUri: + object;
                                                                                                                                                                                                                                                                                        responseType: + string;
                                                                                                                                                                                                                                                                                        state: + object;
                                                                                                                                                                                                                                                                                        [key: + string]: + any;
                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Indexable

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                    • +
                                                                                                                                                                                                                                                                                      + [key: + string]: + any +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Custom parameters to send to /authorize

                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + redirectUri + + responseType + + state +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    + redirectUri: + object +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    + Where the authorization server will redirect back after + success or failure. +

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    + responseType: + string +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    The response_type value

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    + state: + object +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Random string to prevent CSRF attacks.

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                    + + diff --git a/docs/interfaces/ClearSessionOptions.html b/docs/interfaces/ClearSessionOptions.html index 3e1ea655..5c298704 100644 --- a/docs/interfaces/ClearSessionOptions.html +++ b/docs/interfaces/ClearSessionOptions.html @@ -1,6 +1,435 @@ -ClearSessionOptions | react-native-auth0
                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                      Interface ClearSessionOptions

                                                                                                                                                                                                                                                                                      Options for configuring the SDK's clear session behaviour.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      interface ClearSessionOptions {
                                                                                                                                                                                                                                                                                          customScheme?: string;
                                                                                                                                                                                                                                                                                          useLegacyCallbackUrl?: boolean;
                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      customScheme? -useLegacyCallbackUrl? -

                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                      customScheme?: string

                                                                                                                                                                                                                                                                                      Android only: Custom scheme to build the callback URL with.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      useLegacyCallbackUrl?: boolean

                                                                                                                                                                                                                                                                                      This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details.

                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                      + + + + + + ClearSessionOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                        Interface ClearSessionOptions

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Options for configuring the SDK's clear session behaviour.

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + interface + ClearSessionOptions + {
                                                                                                                                                                                                                                                                                            customScheme?: + string;
                                                                                                                                                                                                                                                                                            useLegacyCallbackUrl?: + boolean;
                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + customScheme? + + useLegacyCallbackUrl? +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        + customScheme?: + string +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        + Android only: Custom scheme to build the + callback URL with. +

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        + useLegacyCallbackUrl?: + boolean +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        + This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details. +

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                        + + diff --git a/docs/interfaces/ClearSessionParameters.html b/docs/interfaces/ClearSessionParameters.html index ca92ef1f..dde3cfee 100644 --- a/docs/interfaces/ClearSessionParameters.html +++ b/docs/interfaces/ClearSessionParameters.html @@ -1,14 +1,473 @@ -ClearSessionParameters | react-native-auth0
                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                          Interface ClearSessionParameters

                                                                                                                                                                                                                                                                                          Parameters for sending to the Auth0 logout endpoint.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          interface ClearSessionParameters {
                                                                                                                                                                                                                                                                                              federated?: boolean;
                                                                                                                                                                                                                                                                                              returnToUrl?: string;
                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          federated? -returnToUrl? -

                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                          federated?: boolean

                                                                                                                                                                                                                                                                                          If true, the user will be signed out of any connected identity providers in addition to their Auth0 session.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          false

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          https://auth0.com/docs/authenticate/login/logout/log-users-out-of-idps

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          returnToUrl?: string

                                                                                                                                                                                                                                                                                          Specify a custom redirect URL to be used. Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          If you are using this, ensure a proper redirect URL is constructed in the following format -Android: {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -iOS: {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          If you have useLegacyCallbackUrl set to true then the redirect URL should in the format -Android: {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -iOS: {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                          + + + + + + ClearSessionParameters | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                            Interface ClearSessionParameters

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Parameters for sending to the Auth0 logout endpoint.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + interface + ClearSessionParameters + {
                                                                                                                                                                                                                                                                                                federated?: + boolean;
                                                                                                                                                                                                                                                                                                returnToUrl?: + string;
                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + federated? + + returnToUrl? +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            + federated?: + boolean +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            + If true, the user will be signed out of any + connected identity providers in addition to their Auth0 + session. +

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                            false

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                            + https://auth0.com/docs/authenticate/login/logout/log-users-out-of-idps +

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            + returnToUrl?: + string +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            + Specify a custom redirect URL to be used. Normally, you + wouldn't need to call this method manually as the default + value is autogenerated for you. +

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            + If you are using this, ensure a proper redirect URL is + constructed in the following format Android: + {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback + iOS: + {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback +

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            + If you have useLegacyCallbackUrl set to true then + the redirect URL should in the format Android: + {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback + iOS: + {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback +

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                            + + diff --git a/docs/interfaces/CreateUserOptions.html b/docs/interfaces/CreateUserOptions.html index 0d43b7b4..965e7ba3 100644 --- a/docs/interfaces/CreateUserOptions.html +++ b/docs/interfaces/CreateUserOptions.html @@ -1,24 +1,948 @@ -CreateUserOptions | react-native-auth0
                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                              Interface CreateUserOptions

                                                                                                                                                                                                                                                                                              Options for creating a new user.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              interface CreateUserOptions {
                                                                                                                                                                                                                                                                                                  connection: string;
                                                                                                                                                                                                                                                                                                  email: string;
                                                                                                                                                                                                                                                                                                  family_name?: string;
                                                                                                                                                                                                                                                                                                  given_name?: string;
                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                  metadata?: object;
                                                                                                                                                                                                                                                                                                  name?: string;
                                                                                                                                                                                                                                                                                                  nickname?: string;
                                                                                                                                                                                                                                                                                                  password: string;
                                                                                                                                                                                                                                                                                                  picture?: string;
                                                                                                                                                                                                                                                                                                  username?: string;
                                                                                                                                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                              • [key: string]: any
                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              connection -email -family_name? -given_name? -headers? -metadata? -name? -nickname? -password -picture? -username? -

                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                              connection: string

                                                                                                                                                                                                                                                                                              The name of the database connection where to create the user

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              email: string

                                                                                                                                                                                                                                                                                              The user's email

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              family_name?: string

                                                                                                                                                                                                                                                                                              The user's family name(s)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              given_name?: string

                                                                                                                                                                                                                                                                                              The user's given name(s)

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              headers?: Record<string, string>

                                                                                                                                                                                                                                                                                              (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              metadata?: object

                                                                                                                                                                                                                                                                                              Additional information that will be stored in user_metadata

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              name?: string

                                                                                                                                                                                                                                                                                              The user's full name

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              nickname?: string

                                                                                                                                                                                                                                                                                              The user's nickname

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              password: string

                                                                                                                                                                                                                                                                                              The user's password

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              picture?: string

                                                                                                                                                                                                                                                                                              A URL pointing to the user's picture

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              username?: string

                                                                                                                                                                                                                                                                                              The user's username

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                              + + + + + + CreateUserOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                Interface CreateUserOptions

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Options for creating a new user.

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + interface + CreateUserOptions + {
                                                                                                                                                                                                                                                                                                    connection: + string;
                                                                                                                                                                                                                                                                                                    email: + string;
                                                                                                                                                                                                                                                                                                    family_name?: + string;
                                                                                                                                                                                                                                                                                                    given_name?: + string;
                                                                                                                                                                                                                                                                                                    headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                    metadata?: + object;
                                                                                                                                                                                                                                                                                                    name?: + string;
                                                                                                                                                                                                                                                                                                    nickname?: + string;
                                                                                                                                                                                                                                                                                                    password: + string;
                                                                                                                                                                                                                                                                                                    picture?: + string;
                                                                                                                                                                                                                                                                                                    username?: + string;
                                                                                                                                                                                                                                                                                                    [key: + string]: + any;
                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                Indexable

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

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + connection + + email + + family_name? + + given_name? + + headers? + + metadata? + + name? + + nickname? + + password + + picture? + + username? +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + connection: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                + The name of the database connection where to create the user +

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + email: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                The user's email

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + family_name?: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                The user's family name(s)

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + given_name?: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                The user's given name(s)

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + metadata?: + object +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                + Additional information that will be stored in + user_metadata +

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + name?: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                The user's full name

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + nickname?: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                The user's nickname

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + password: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                The user's password

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + picture?: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                A URL pointing to the user's picture

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                + username?: + string +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                The user's username

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                + + diff --git a/docs/interfaces/ExchangeNativeSocialOptions.html b/docs/interfaces/ExchangeNativeSocialOptions.html index 872534cc..6852d8b2 100644 --- a/docs/interfaces/ExchangeNativeSocialOptions.html +++ b/docs/interfaces/ExchangeNativeSocialOptions.html @@ -1,14 +1,687 @@ -ExchangeNativeSocialOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                  Interface ExchangeNativeSocialOptions

                                                                                                                                                                                                                                                                                                  Options for obtaining user tokens from an external provider's token

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  interface ExchangeNativeSocialOptions {
                                                                                                                                                                                                                                                                                                      audience?: string;
                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                      subjectToken: string;
                                                                                                                                                                                                                                                                                                      subjectTokenType: string;
                                                                                                                                                                                                                                                                                                      userProfile?: string;
                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  audience? -headers? -scope? -subjectToken -subjectTokenType -userProfile? -

                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                  audience?: string

                                                                                                                                                                                                                                                                                                  The API audience to request

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                  (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  scope?: string

                                                                                                                                                                                                                                                                                                  The scopes requested for the issued tokens. e.g. openid profile

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  subjectToken: string

                                                                                                                                                                                                                                                                                                  The token returned by the native social authentication solution

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  subjectTokenType: string

                                                                                                                                                                                                                                                                                                  The identifier that indicates the native social authentication solution

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  userProfile?: string

                                                                                                                                                                                                                                                                                                  Additional profile attributes to set or override, only on select native social authentication solutions

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                  + + + + + + ExchangeNativeSocialOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                    Interface ExchangeNativeSocialOptions

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    + Options for obtaining user tokens from an external provider's + token +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + interface + ExchangeNativeSocialOptions + {
                                                                                                                                                                                                                                                                                                        audience?: + string;
                                                                                                                                                                                                                                                                                                        headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                        scope?: + string;
                                                                                                                                                                                                                                                                                                        subjectToken: + string;
                                                                                                                                                                                                                                                                                                        subjectTokenType: + string;
                                                                                                                                                                                                                                                                                                        userProfile?: + string;
                                                                                                                                                                                                                                                                                                        [key: + string]: + any;
                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Indexable

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

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + audience? + + headers? + + scope? + + subjectToken + + subjectTokenType + + userProfile? +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    + audience?: + string +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    The API audience to request

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    + scope?: + string +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    + The scopes requested for the issued tokens. e.g. + openid profile +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    + subjectToken: + string +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    + The token returned by the native social authentication + solution +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    + subjectTokenType: + string +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    + The identifier that indicates the native social authentication + solution +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    + userProfile?: + string +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    + Additional profile attributes to set or override, only on + select native social authentication solutions +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/interfaces/ExchangeOptions.html b/docs/interfaces/ExchangeOptions.html index ac5fb09c..eae3c5a8 100644 --- a/docs/interfaces/ExchangeOptions.html +++ b/docs/interfaces/ExchangeOptions.html @@ -1,9 +1,507 @@ -ExchangeOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                      Interface ExchangeOptions

                                                                                                                                                                                                                                                                                                      Options for the /oauth/token endpoint to exchange a code for an access token

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      interface ExchangeOptions {
                                                                                                                                                                                                                                                                                                          code: string;
                                                                                                                                                                                                                                                                                                          redirectUri: string;
                                                                                                                                                                                                                                                                                                          verifier: string;
                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                      • [key: string]: any

                                                                                                                                                                                                                                                                                                        Custom parameters to send to the /oauth/token endpoint

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      code -redirectUri -verifier -

                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                      code: string

                                                                                                                                                                                                                                                                                                      The code returned by /authorize.

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      redirectUri: string

                                                                                                                                                                                                                                                                                                      The original redirectUri used when calling /authorize.

                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                      verifier: string

                                                                                                                                                                                                                                                                                                      The value used to generate the code challenge sent to /authorize.

                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                      + + + + + + ExchangeOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                        Interface ExchangeOptions

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        + Options for the /oauth/token endpoint to exchange a + code for an access token +

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + interface + ExchangeOptions + {
                                                                                                                                                                                                                                                                                                            code: + string;
                                                                                                                                                                                                                                                                                                            redirectUri: + string;
                                                                                                                                                                                                                                                                                                            verifier: + string;
                                                                                                                                                                                                                                                                                                            [key: + string]: + any;
                                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                          + [key: + string]: + any +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Custom parameters to send to the /oauth/token endpoint

                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + code + + redirectUri + + verifier +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        + code: + string +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        The code returned by /authorize.

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        + redirectUri: + string +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        + The original redirectUri used when calling + /authorize. +

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        + verifier: + string +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        + The value used to generate the code challenge sent to + /authorize. +

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/interfaces/GetUserOptions.html b/docs/interfaces/GetUserOptions.html index dec594fb..80e2e4af 100644 --- a/docs/interfaces/GetUserOptions.html +++ b/docs/interfaces/GetUserOptions.html @@ -1,4 +1,439 @@ -GetUserOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                          Interface GetUserOptions

                                                                                                                                                                                                                                                                                                          interface GetUserOptions {
                                                                                                                                                                                                                                                                                                              headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                          • [key: string]: any
                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          headers? -id -

                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                          headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                          (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                          id: string

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                          + + + + + + GetUserOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                            Interface GetUserOptions

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + interface + GetUserOptions + {
                                                                                                                                                                                                                                                                                                                headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                id: + string;
                                                                                                                                                                                                                                                                                                                [key: + string]: + any;
                                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + headers? + + id +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            + id: + string +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/interfaces/LocalAuthenticationOptions.html b/docs/interfaces/LocalAuthenticationOptions.html index 48423fde..e96fc54d 100644 --- a/docs/interfaces/LocalAuthenticationOptions.html +++ b/docs/interfaces/LocalAuthenticationOptions.html @@ -1,18 +1,800 @@ -LocalAuthenticationOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                              Interface LocalAuthenticationOptions

                                                                                                                                                                                                                                                                                                              The options for configuring the display of local authentication prompt, authentication level (Android only) and evaluation policy (iOS only).

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              interface LocalAuthenticationOptions {
                                                                                                                                                                                                                                                                                                                  authenticationLevel?: LocalAuthenticationLevel;
                                                                                                                                                                                                                                                                                                                  cancelTitle?: String;
                                                                                                                                                                                                                                                                                                                  description?: String;
                                                                                                                                                                                                                                                                                                                  deviceCredentialFallback?: Boolean;
                                                                                                                                                                                                                                                                                                                  evaluationPolicy?: LocalAuthenticationStrategy;
                                                                                                                                                                                                                                                                                                                  fallbackTitle?: String;
                                                                                                                                                                                                                                                                                                                  subtitle?: String;
                                                                                                                                                                                                                                                                                                                  title: String;
                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              authenticationLevel? -cancelTitle? -description? -deviceCredentialFallback? -evaluationPolicy? -fallbackTitle? -subtitle? -title -

                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                              authenticationLevel?: LocalAuthenticationLevel

                                                                                                                                                                                                                                                                                                              The authentication level to use when prompting the user for authentication. Defaults to LocalAuthenticationLevel.strong. Applicable for Android only.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              cancelTitle?: String

                                                                                                                                                                                                                                                                                                              The cancel button title of the authentication prompt. Applicable for both Android and iOS.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              description?: String

                                                                                                                                                                                                                                                                                                              The description of the authentication prompt. Applicable for Android only.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              deviceCredentialFallback?: Boolean

                                                                                                                                                                                                                                                                                                              Should the user be given the option to authenticate with their device PIN, pattern, or password instead of a biometric. Applicable for Android only.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              evaluationPolicy?: LocalAuthenticationStrategy

                                                                                                                                                                                                                                                                                                              The evaluation policy to use when prompting the user for authentication. Defaults to LocalAuthenticationStrategy.deviceOwnerWithBiometrics. Applicable for iOS only.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              fallbackTitle?: String

                                                                                                                                                                                                                                                                                                              The fallback button title of the authentication prompt. Applicable for iOS only.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              subtitle?: String

                                                                                                                                                                                                                                                                                                              The subtitle of the authentication prompt. Applicable for Android only.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                              title: String

                                                                                                                                                                                                                                                                                                              The title of the authentication prompt. Applicable for both Android and iOS.

                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                              + + + + + + LocalAuthenticationOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                Interface LocalAuthenticationOptions

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The options for configuring the display of local authentication + prompt, authentication level (Android only) and evaluation policy + (iOS only). +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + interface + LocalAuthenticationOptions + {
                                                                                                                                                                                                                                                                                                                    authenticationLevel?: + LocalAuthenticationLevel;
                                                                                                                                                                                                                                                                                                                    cancelTitle?: + String;
                                                                                                                                                                                                                                                                                                                    description?: + String;
                                                                                                                                                                                                                                                                                                                    deviceCredentialFallback?: + Boolean;
                                                                                                                                                                                                                                                                                                                    evaluationPolicy?: + LocalAuthenticationStrategy;
                                                                                                                                                                                                                                                                                                                    fallbackTitle?: + String;
                                                                                                                                                                                                                                                                                                                    subtitle?: + String;
                                                                                                                                                                                                                                                                                                                    title: + String;
                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + authenticationLevel? + + cancelTitle? + + description? + + deviceCredentialFallback? + + evaluationPolicy? + + fallbackTitle? + + subtitle? + + title +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + authenticationLevel?: + LocalAuthenticationLevel +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The authentication level to use when prompting the user for + authentication. Defaults to LocalAuthenticationLevel.strong. + Applicable for Android only. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + cancelTitle?: + String +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The cancel button title of the authentication prompt. + Applicable for both Android and iOS. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + description?: + String +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The description of the authentication prompt. + Applicable for Android only. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + deviceCredentialFallback?: + Boolean +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + Should the user be given the option to authenticate with their + device PIN, pattern, or password instead of a biometric. + Applicable for Android only. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + evaluationPolicy?: + LocalAuthenticationStrategy +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The evaluation policy to use when prompting the user for + authentication. Defaults to + LocalAuthenticationStrategy.deviceOwnerWithBiometrics. + Applicable for iOS only. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + fallbackTitle?: + String +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The fallback button title of the authentication prompt. + Applicable for iOS only. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + subtitle?: + String +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The subtitle of the authentication prompt. + Applicable for Android only. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                + title: + String +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + The title of the authentication prompt. + Applicable for both Android and iOS. +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                + + diff --git a/docs/interfaces/LoginWithEmailOptions.html b/docs/interfaces/LoginWithEmailOptions.html index a0cc995f..0b0d01fe 100644 --- a/docs/interfaces/LoginWithEmailOptions.html +++ b/docs/interfaces/LoginWithEmailOptions.html @@ -1,12 +1,611 @@ -LoginWithEmailOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                  Interface LoginWithEmailOptions

                                                                                                                                                                                                                                                                                                                  The options for completing the passwordless login with email request

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  interface LoginWithEmailOptions {
                                                                                                                                                                                                                                                                                                                      audience?: string;
                                                                                                                                                                                                                                                                                                                      code: string;
                                                                                                                                                                                                                                                                                                                      email: string;
                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  audience? -code -email -headers? -scope? -

                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                  audience?: string

                                                                                                                                                                                                                                                                                                                  The API audience to request

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  code: string

                                                                                                                                                                                                                                                                                                                  The code numeric value (OTP)

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  email: string

                                                                                                                                                                                                                                                                                                                  The email where the link/code was received

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                  (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                  scope?: string

                                                                                                                                                                                                                                                                                                                  The scopes to request

                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                  + + + + + + LoginWithEmailOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                    Interface LoginWithEmailOptions

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    + The options for completing the passwordless login with email + request +

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + interface + LoginWithEmailOptions + {
                                                                                                                                                                                                                                                                                                                        audience?: + string;
                                                                                                                                                                                                                                                                                                                        code: + string;
                                                                                                                                                                                                                                                                                                                        email: + string;
                                                                                                                                                                                                                                                                                                                        headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                        scope?: + string;
                                                                                                                                                                                                                                                                                                                        [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    Indexable

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

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + audience? + + code + + email + + headers? + + scope? +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    + audience?: + string +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    The API audience to request

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    + code: + string +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    The code numeric value (OTP)

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    + email: + string +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    The email where the link/code was received

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    + scope?: + string +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    The scopes to request

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/interfaces/LoginWithOOBOptions.html b/docs/interfaces/LoginWithOOBOptions.html index 14554c31..9ae4adc1 100644 --- a/docs/interfaces/LoginWithOOBOptions.html +++ b/docs/interfaces/LoginWithOOBOptions.html @@ -1,12 +1,568 @@ -LoginWithOOBOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                      Interface LoginWithOOBOptions

                                                                                                                                                                                                                                                                                                                      Options for logging in using an OOB code

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      interface LoginWithOOBOptions {
                                                                                                                                                                                                                                                                                                                          bindingCode?: string;
                                                                                                                                                                                                                                                                                                                          headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                          mfaToken: string;
                                                                                                                                                                                                                                                                                                                          oobCode: string;
                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      bindingCode? -headers? -mfaToken -oobCode -

                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                      bindingCode?: string

                                                                                                                                                                                                                                                                                                                      The code used to bind the side channel (used to deliver the challenge) with the -main channel you are using to authenticate. This is usually an OTP-like code -delivered as part of the challenge message.

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                      (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      mfaToken: string

                                                                                                                                                                                                                                                                                                                      The token received in the previous login response

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      oobCode: string

                                                                                                                                                                                                                                                                                                                      The out of band code received in the challenge response.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                      + + + + + + LoginWithOOBOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                        Interface LoginWithOOBOptions

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Options for logging in using an OOB code

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + interface + LoginWithOOBOptions + {
                                                                                                                                                                                                                                                                                                                            bindingCode?: + string;
                                                                                                                                                                                                                                                                                                                            headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                            mfaToken: + string;
                                                                                                                                                                                                                                                                                                                            oobCode: + string;
                                                                                                                                                                                                                                                                                                                            [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Indexable

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

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + bindingCode? + + headers? + + mfaToken + + oobCode +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        + bindingCode?: + string +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + The code used to bind the side channel (used to deliver the + challenge) with the main channel you are using to + authenticate. This is usually an OTP-like code delivered as + part of the challenge message. +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        + mfaToken: + string +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        The token received in the previous login response

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        + oobCode: + string +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        The out of band code received in the challenge response.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/interfaces/LoginWithOTPOptions.html b/docs/interfaces/LoginWithOTPOptions.html index e8bfe3f1..77d9f821 100644 --- a/docs/interfaces/LoginWithOTPOptions.html +++ b/docs/interfaces/LoginWithOTPOptions.html @@ -1,11 +1,563 @@ -LoginWithOTPOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                          Interface LoginWithOTPOptions

                                                                                                                                                                                                                                                                                                                          Options for logging in using an OTP code

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          interface LoginWithOTPOptions {
                                                                                                                                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                                                                                                                                              headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                              mfaToken: string;
                                                                                                                                                                                                                                                                                                                              otp: string;
                                                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                          • [key: string]: any
                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          audience? -headers? -mfaToken -otp -

                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                          audience?: string

                                                                                                                                                                                                                                                                                                                          The API audience

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                          (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          mfaToken: string

                                                                                                                                                                                                                                                                                                                          The token received in the previous login response

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          otp: string

                                                                                                                                                                                                                                                                                                                          The one time password code provided by the resource owner, typically obtained -from an MFA application such as Google Authenticator or Guardian.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                          + + + + + + LoginWithOTPOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                            Interface LoginWithOTPOptions

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Options for logging in using an OTP code

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + interface + LoginWithOTPOptions + {
                                                                                                                                                                                                                                                                                                                                audience?: + string;
                                                                                                                                                                                                                                                                                                                                headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                mfaToken: + string;
                                                                                                                                                                                                                                                                                                                                otp: + string;
                                                                                                                                                                                                                                                                                                                                [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + audience? + + headers? + + mfaToken + + otp +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            + audience?: + string +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            The API audience

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            + mfaToken: + string +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            The token received in the previous login response

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            + otp: + string +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            + The one time password code provided by the resource owner, + typically obtained from an MFA application such as Google + Authenticator or Guardian. +

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/interfaces/LoginWithRecoveryCodeOptions.html b/docs/interfaces/LoginWithRecoveryCodeOptions.html index c0d214c7..95f264b3 100644 --- a/docs/interfaces/LoginWithRecoveryCodeOptions.html +++ b/docs/interfaces/LoginWithRecoveryCodeOptions.html @@ -1,8 +1,509 @@ -LoginWithRecoveryCodeOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                              Interface LoginWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                              Options for logging in using a recovery code

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              interface LoginWithRecoveryCodeOptions {
                                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                  mfaToken: string;
                                                                                                                                                                                                                                                                                                                                  recoveryCode: string;
                                                                                                                                                                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                              • [key: string]: any
                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              headers? -mfaToken -recoveryCode -

                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                              headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                              (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              mfaToken: string

                                                                                                                                                                                                                                                                                                                              The token received in the previous login response

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                              recoveryCode: string

                                                                                                                                                                                                                                                                                                                              The recovery code provided by the end-user.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                              + + + + + + LoginWithRecoveryCodeOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                Interface LoginWithRecoveryCodeOptions

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Options for logging in using a recovery code

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + interface + LoginWithRecoveryCodeOptions + {
                                                                                                                                                                                                                                                                                                                                    headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                    mfaToken: + string;
                                                                                                                                                                                                                                                                                                                                    recoveryCode: + string;
                                                                                                                                                                                                                                                                                                                                    [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Indexable

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

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + headers? + + mfaToken + + recoveryCode +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                + mfaToken: + string +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                The token received in the previous login response

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                + recoveryCode: + string +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                The recovery code provided by the end-user.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                + + diff --git a/docs/interfaces/LoginWithSMSOptions.html b/docs/interfaces/LoginWithSMSOptions.html index eee64367..e2322d3d 100644 --- a/docs/interfaces/LoginWithSMSOptions.html +++ b/docs/interfaces/LoginWithSMSOptions.html @@ -1,12 +1,613 @@ -LoginWithSMSOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                  Interface LoginWithSMSOptions

                                                                                                                                                                                                                                                                                                                                  The options for completing the passwordless login with SMS request

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  interface LoginWithSMSOptions {
                                                                                                                                                                                                                                                                                                                                      audience?: string;
                                                                                                                                                                                                                                                                                                                                      code: string;
                                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                      phoneNumber: string;
                                                                                                                                                                                                                                                                                                                                      scope?: string;
                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  audience? -code -headers? -phoneNumber -scope? -

                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                  audience?: string

                                                                                                                                                                                                                                                                                                                                  Optional API audience to request

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  code: string

                                                                                                                                                                                                                                                                                                                                  The code numeric value (OTP)

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                  (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  phoneNumber: string

                                                                                                                                                                                                                                                                                                                                  The phone number where the code was received

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  scope?: string

                                                                                                                                                                                                                                                                                                                                  Optional scopes to request

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                  + + + + + + LoginWithSMSOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                    Interface LoginWithSMSOptions

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    + The options for completing the passwordless login with SMS request +

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + interface + LoginWithSMSOptions + {
                                                                                                                                                                                                                                                                                                                                        audience?: + string;
                                                                                                                                                                                                                                                                                                                                        code: + string;
                                                                                                                                                                                                                                                                                                                                        headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                        phoneNumber: + string;
                                                                                                                                                                                                                                                                                                                                        scope?: + string;
                                                                                                                                                                                                                                                                                                                                        [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Indexable

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

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + audience? + + code + + headers? + + phoneNumber + + scope? +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    + audience?: + string +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Optional API audience to request

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    + code: + string +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    The code numeric value (OTP)

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    + phoneNumber: + string +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    The phone number where the code was received

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    + scope?: + string +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    Optional scopes to request

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index f566f2d9..c844c761 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,9 +1,507 @@ -LogoutUrlOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                      Interface LogoutUrlOptions

                                                                                                                                                                                                                                                                                                                                      Options for the logout endpoint

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      interface LogoutUrlOptions {
                                                                                                                                                                                                                                                                                                                                          clientId?: string;
                                                                                                                                                                                                                                                                                                                                          federated?: boolean;
                                                                                                                                                                                                                                                                                                                                          returnTo?: string;
                                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                      • [key: string]: any

                                                                                                                                                                                                                                                                                                                                        Custom parameters to send to the logout endpoint

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      clientId? -federated? -returnTo? -

                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                      clientId?: string

                                                                                                                                                                                                                                                                                                                                      The client identifier of the one requesting the logout

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      federated?: boolean

                                                                                                                                                                                                                                                                                                                                      Whether the logout should include removing session for federated IdP.

                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                      returnTo?: string

                                                                                                                                                                                                                                                                                                                                      URL where the user is redirected to after logout. It must be declared in you Auth0 Dashboard

                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                      + + + + + + LogoutUrlOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                        Interface LogoutUrlOptions

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Options for the logout endpoint

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + interface + LogoutUrlOptions + {
                                                                                                                                                                                                                                                                                                                                            clientId?: + string;
                                                                                                                                                                                                                                                                                                                                            federated?: + boolean;
                                                                                                                                                                                                                                                                                                                                            returnTo?: + string;
                                                                                                                                                                                                                                                                                                                                            [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Indexable

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                        • +
                                                                                                                                                                                                                                                                                                                                          + [key: + string]: + any +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Custom parameters to send to the logout endpoint

                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + clientId? + + federated? + + returnTo? +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        + clientId?: + string +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        The client identifier of the one requesting the logout

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        + federated?: + boolean +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        + Whether the logout should include removing session for + federated IdP. +

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        + returnTo?: + string +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        + URL where the user is redirected to after logout. It must be + declared in you Auth0 Dashboard +

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/interfaces/MultifactorChallengeOptions.html b/docs/interfaces/MultifactorChallengeOptions.html index 7dd84d46..c1f03e1f 100644 --- a/docs/interfaces/MultifactorChallengeOptions.html +++ b/docs/interfaces/MultifactorChallengeOptions.html @@ -1,12 +1,571 @@ -MultifactorChallengeOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                          Interface MultifactorChallengeOptions

                                                                                                                                                                                                                                                                                                                                          Options for multifactor challenge.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          interface MultifactorChallengeOptions {
                                                                                                                                                                                                                                                                                                                                              authenticatorId?: string;
                                                                                                                                                                                                                                                                                                                                              challengeType?: string;
                                                                                                                                                                                                                                                                                                                                              headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                              mfaToken: string;
                                                                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                          • [key: string]: any
                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          authenticatorId? -challengeType? -headers? -mfaToken -

                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                          authenticatorId?: string

                                                                                                                                                                                                                                                                                                                                          The ID of the authenticator to challenge.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          challengeType?: string

                                                                                                                                                                                                                                                                                                                                          A whitespace-separated list of the challenges types accepted by your application. -Accepted challenge types are oob or otp. Excluding this parameter means that your client application -accepts all supported challenge types.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                          (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                          mfaToken: string

                                                                                                                                                                                                                                                                                                                                          The token received in the previous login response

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                          + + + + + + MultifactorChallengeOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                            Interface MultifactorChallengeOptions

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Options for multifactor challenge.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + interface + MultifactorChallengeOptions + {
                                                                                                                                                                                                                                                                                                                                                authenticatorId?: + string;
                                                                                                                                                                                                                                                                                                                                                challengeType?: + string;
                                                                                                                                                                                                                                                                                                                                                headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                mfaToken: + string;
                                                                                                                                                                                                                                                                                                                                                [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + authenticatorId? + + challengeType? + + headers? + + mfaToken +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            + authenticatorId?: + string +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            The ID of the authenticator to challenge.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            + challengeType?: + string +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            + A whitespace-separated list of the challenges types accepted + by your application. Accepted challenge types are oob or otp. + Excluding this parameter means that your client application + accepts all supported challenge types. +

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            + mfaToken: + string +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            The token received in the previous login response

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/interfaces/PasswordRealmOptions.html b/docs/interfaces/PasswordRealmOptions.html index 0297523f..9f2d8f85 100644 --- a/docs/interfaces/PasswordRealmOptions.html +++ b/docs/interfaces/PasswordRealmOptions.html @@ -1,14 +1,675 @@ -PasswordRealmOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                              Interface PasswordRealmOptions

                                                                                                                                                                                                                                                                                                                                              Options for authenticating using the username & password grant.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              interface PasswordRealmOptions {
                                                                                                                                                                                                                                                                                                                                                  audience?: string;
                                                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                  password: string;
                                                                                                                                                                                                                                                                                                                                                  realm: string;
                                                                                                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                                                                                                  username: string;
                                                                                                                                                                                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                              • [key: string]: any
                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              audience? -headers? -password -realm -scope? -username -

                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                              audience?: string

                                                                                                                                                                                                                                                                                                                                              The identifier of Resource Server (RS) to be included as audience (aud claim) of the issued access token

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                              (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              password: string

                                                                                                                                                                                                                                                                                                                                              The user's password

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              realm: string

                                                                                                                                                                                                                                                                                                                                              The name of the Realm where to Auth (or connection name)

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              scope?: string

                                                                                                                                                                                                                                                                                                                                              The scopes requested for the issued tokens. e.g. openid profile

                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                              username: string

                                                                                                                                                                                                                                                                                                                                              The user's username or email

                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                              + + + + + + PasswordRealmOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                Interface PasswordRealmOptions

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                + Options for authenticating using the username & password + grant. +

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + interface + PasswordRealmOptions + {
                                                                                                                                                                                                                                                                                                                                                    audience?: + string;
                                                                                                                                                                                                                                                                                                                                                    headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                    password: + string;
                                                                                                                                                                                                                                                                                                                                                    realm: + string;
                                                                                                                                                                                                                                                                                                                                                    scope?: + string;
                                                                                                                                                                                                                                                                                                                                                    username: + string;
                                                                                                                                                                                                                                                                                                                                                    [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Indexable

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

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + audience? + + headers? + + password + + realm + + scope? + + username +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                + audience?: + string +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                + The identifier of Resource Server (RS) to be included as + audience (aud claim) of the issued access token +

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                + password: + string +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                The user's password

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                + realm: + string +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                The name of the Realm where to Auth (or connection name)

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                + scope?: + string +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                + The scopes requested for the issued tokens. e.g. + openid profile +

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                + username: + string +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                The user's username or email

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                + + diff --git a/docs/interfaces/PasswordlessWithEmailOptions.html b/docs/interfaces/PasswordlessWithEmailOptions.html index 0bdbeae2..fe8a1ff3 100644 --- a/docs/interfaces/PasswordlessWithEmailOptions.html +++ b/docs/interfaces/PasswordlessWithEmailOptions.html @@ -1,10 +1,559 @@ -PasswordlessWithEmailOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                  Interface PasswordlessWithEmailOptions

                                                                                                                                                                                                                                                                                                                                                  Options for requesting passwordless login using email

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  interface PasswordlessWithEmailOptions {
                                                                                                                                                                                                                                                                                                                                                      authParams?: object;
                                                                                                                                                                                                                                                                                                                                                      email: string;
                                                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                      send?: string;
                                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  authParams? -email -headers? -send? -

                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                  authParams?: object

                                                                                                                                                                                                                                                                                                                                                  Optional parameters, used when strategy is 'linḱ'

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  email: string

                                                                                                                                                                                                                                                                                                                                                  The email to send the link/code to

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                  (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  send?: string

                                                                                                                                                                                                                                                                                                                                                  The passwordless strategy, either 'link' or 'code'

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                  + + + + + + PasswordlessWithEmailOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                    Interface PasswordlessWithEmailOptions

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Options for requesting passwordless login using email

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + interface + PasswordlessWithEmailOptions + {
                                                                                                                                                                                                                                                                                                                                                        authParams?: + object;
                                                                                                                                                                                                                                                                                                                                                        email: + string;
                                                                                                                                                                                                                                                                                                                                                        headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                        send?: + string;
                                                                                                                                                                                                                                                                                                                                                        [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Indexable

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

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + authParams? + + email + + headers? + + send? +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    + authParams?: + object +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Optional parameters, used when strategy is 'linḱ'

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    + email: + string +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    The email to send the link/code to

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    + send?: + string +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    The passwordless strategy, either 'link' or 'code'

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/interfaces/PasswordlessWithSMSOptions.html b/docs/interfaces/PasswordlessWithSMSOptions.html index d371e4a2..77a9e8e2 100644 --- a/docs/interfaces/PasswordlessWithSMSOptions.html +++ b/docs/interfaces/PasswordlessWithSMSOptions.html @@ -1,10 +1,562 @@ -PasswordlessWithSMSOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                      Interface PasswordlessWithSMSOptions

                                                                                                                                                                                                                                                                                                                                                      Options for requesting passwordless login using SMS

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      interface PasswordlessWithSMSOptions {
                                                                                                                                                                                                                                                                                                                                                          authParams?: object;
                                                                                                                                                                                                                                                                                                                                                          headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                          phoneNumber: string;
                                                                                                                                                                                                                                                                                                                                                          send?: string;
                                                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      authParams? -headers? -phoneNumber -send? -

                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                      authParams?: object

                                                                                                                                                                                                                                                                                                                                                      Optional passwordless parameters

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                      (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      phoneNumber: string

                                                                                                                                                                                                                                                                                                                                                      The phone number to send the link/code to

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      send?: string

                                                                                                                                                                                                                                                                                                                                                      The passwordless strategy, either 'link' or 'code'

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                      + + + + + + PasswordlessWithSMSOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                        Interface PasswordlessWithSMSOptions

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Options for requesting passwordless login using SMS

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + interface + PasswordlessWithSMSOptions + {
                                                                                                                                                                                                                                                                                                                                                            authParams?: + object;
                                                                                                                                                                                                                                                                                                                                                            headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                            phoneNumber: + string;
                                                                                                                                                                                                                                                                                                                                                            send?: + string;
                                                                                                                                                                                                                                                                                                                                                            [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Indexable

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

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + authParams? + + headers? + + phoneNumber + + send? +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        + authParams?: + object +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Optional passwordless parameters

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        + phoneNumber: + string +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        The phone number to send the link/code to

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        + send?: + string +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        The passwordless strategy, either 'link' or 'code'

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/interfaces/PatchUserOptions.html b/docs/interfaces/PatchUserOptions.html index 7dd272a8..b1307211 100644 --- a/docs/interfaces/PatchUserOptions.html +++ b/docs/interfaces/PatchUserOptions.html @@ -1,5 +1,490 @@ -PatchUserOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                          Interface PatchUserOptions

                                                                                                                                                                                                                                                                                                                                                          interface PatchUserOptions {
                                                                                                                                                                                                                                                                                                                                                              headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                              id: string;
                                                                                                                                                                                                                                                                                                                                                              metadata: object;
                                                                                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                          • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          headers? -id -metadata -

                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                          headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                          (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                          id: string
                                                                                                                                                                                                                                                                                                                                                          metadata: object

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                          + + + + + + PatchUserOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                            Interface PatchUserOptions

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + interface + PatchUserOptions + {
                                                                                                                                                                                                                                                                                                                                                                headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                                id: + string;
                                                                                                                                                                                                                                                                                                                                                                metadata: + object;
                                                                                                                                                                                                                                                                                                                                                                [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + headers? + + id + + metadata +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            + id: + string +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            + metadata: + object +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/interfaces/RefreshTokenOptions.html b/docs/interfaces/RefreshTokenOptions.html index 695848a8..93850f7b 100644 --- a/docs/interfaces/RefreshTokenOptions.html +++ b/docs/interfaces/RefreshTokenOptions.html @@ -1,8 +1,507 @@ -RefreshTokenOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                              Interface RefreshTokenOptions

                                                                                                                                                                                                                                                                                                                                                              Refresh token parameters

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              interface RefreshTokenOptions {
                                                                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                  refreshToken: string;
                                                                                                                                                                                                                                                                                                                                                                  scope?: string;
                                                                                                                                                                                                                                                                                                                                                                  [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Indexable

                                                                                                                                                                                                                                                                                                                                                              • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              headers? -refreshToken -scope? -

                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                              headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                              (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              refreshToken: string

                                                                                                                                                                                                                                                                                                                                                              The issued refresh token

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                              scope?: string

                                                                                                                                                                                                                                                                                                                                                              The scopes requested for the issued tokens. e.g. openid profile

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                              + + + + + + RefreshTokenOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                Interface RefreshTokenOptions

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Refresh token parameters

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + interface + RefreshTokenOptions + {
                                                                                                                                                                                                                                                                                                                                                                    headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                                    refreshToken: + string;
                                                                                                                                                                                                                                                                                                                                                                    scope?: + string;
                                                                                                                                                                                                                                                                                                                                                                    [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Indexable

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

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + headers? + + refreshToken + + scope? +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                + refreshToken: + string +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                The issued refresh token

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                + scope?: + string +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                + The scopes requested for the issued tokens. e.g. + openid profile +

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                + + diff --git a/docs/interfaces/ResetPasswordOptions.html b/docs/interfaces/ResetPasswordOptions.html index c9c16e77..ad1a8634 100644 --- a/docs/interfaces/ResetPasswordOptions.html +++ b/docs/interfaces/ResetPasswordOptions.html @@ -1,8 +1,504 @@ -ResetPasswordOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                  Interface ResetPasswordOptions

                                                                                                                                                                                                                                                                                                                                                                  Options for resetting a user's password.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  interface ResetPasswordOptions {
                                                                                                                                                                                                                                                                                                                                                                      connection: string;
                                                                                                                                                                                                                                                                                                                                                                      email: string;
                                                                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Indexable

                                                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  connection -email -headers? -

                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                  connection: string

                                                                                                                                                                                                                                                                                                                                                                  The name of the database connection of the user

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  email: string

                                                                                                                                                                                                                                                                                                                                                                  The user's email

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                  (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                  + + + + + + ResetPasswordOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                    Interface ResetPasswordOptions

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Options for resetting a user's password.

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + interface + ResetPasswordOptions + {
                                                                                                                                                                                                                                                                                                                                                                        connection: + string;
                                                                                                                                                                                                                                                                                                                                                                        email: + string;
                                                                                                                                                                                                                                                                                                                                                                        headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                                        [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Indexable

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

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + connection + + email + + headers? +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    + connection: + string +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    The name of the database connection of the user

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    + email: + string +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    The user's email

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/interfaces/RevokeOptions.html b/docs/interfaces/RevokeOptions.html index 11acfadc..f100cc9b 100644 --- a/docs/interfaces/RevokeOptions.html +++ b/docs/interfaces/RevokeOptions.html @@ -1,6 +1,452 @@ -RevokeOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                      Interface RevokeOptions

                                                                                                                                                                                                                                                                                                                                                                      Options for the revoke refresh token endpoint.

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      interface RevokeOptions {
                                                                                                                                                                                                                                                                                                                                                                          headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                          refreshToken: string;
                                                                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      headers? -refreshToken -

                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                      (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      refreshToken: string

                                                                                                                                                                                                                                                                                                                                                                      The user's issued refresh token

                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                      + + + + + + RevokeOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                        Interface RevokeOptions

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Options for the revoke refresh token endpoint.

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + interface + RevokeOptions + {
                                                                                                                                                                                                                                                                                                                                                                            headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                                            refreshToken: + string;
                                                                                                                                                                                                                                                                                                                                                                            [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        Indexable

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

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + headers? + + refreshToken +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        + refreshToken: + string +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        The user's issued refresh token

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/interfaces/Types.Auth0ContextInterface.html b/docs/interfaces/Types.Auth0ContextInterface.html index e0628132..03c733cf 100644 --- a/docs/interfaces/Types.Auth0ContextInterface.html +++ b/docs/interfaces/Types.Auth0ContextInterface.html @@ -1,55 +1,2676 @@ -Auth0ContextInterface | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                          Interface Auth0ContextInterface<TUser>

                                                                                                                                                                                                                                                                                                                                                                          interface Auth0ContextInterface<TUser extends User = User> {
                                                                                                                                                                                                                                                                                                                                                                              authorize: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters?: WebAuthorizeParameters,
                                                                                                                                                                                                                                                                                                                                                                                  options?: WebAuthorizeOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              authorizeWithEmail: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: LoginWithEmailOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              authorizeWithExchangeNativeSocial: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: ExchangeNativeSocialOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              authorizeWithOOB: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: LoginWithOOBOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              authorizeWithOTP: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: LoginWithOTPOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              authorizeWithPasswordRealm: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: PasswordRealmOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              authorizeWithRecoveryCode: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: LoginWithRecoveryCodeOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              authorizeWithSMS: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: LoginWithSMSOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              cancelWebAuth: () => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              clearCredentials: () => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              clearSession: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters?: ClearSessionParameters,
                                                                                                                                                                                                                                                                                                                                                                                  options?: ClearSessionOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              error: null | BaseError;
                                                                                                                                                                                                                                                                                                                                                                              getCredentials: (
                                                                                                                                                                                                                                                                                                                                                                                  scope?: string,
                                                                                                                                                                                                                                                                                                                                                                                  minTtl?: number,
                                                                                                                                                                                                                                                                                                                                                                                  parameters?: Record<string, unknown>,
                                                                                                                                                                                                                                                                                                                                                                                  forceRefresh?: boolean,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<undefined | Credentials>;
                                                                                                                                                                                                                                                                                                                                                                              hasValidCredentials: (minTtl?: number) => Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                              isLoading: boolean;
                                                                                                                                                                                                                                                                                                                                                                              resetPassword: (parameters: ResetPasswordOptions) => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              revokeRefreshToken: (parameters: RevokeOptions) => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              sendEmailCode: (parameters: PasswordlessWithEmailOptions) => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              sendMultifactorChallenge: (
                                                                                                                                                                                                                                                                                                                                                                                  parameters: MultifactorChallengeOptions,
                                                                                                                                                                                                                                                                                                                                                                              ) => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              sendSMSCode: (parameters: PasswordlessWithSMSOptions) => Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                              user: null | TUser;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                                          Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          authorize -authorizeWithEmail -authorizeWithExchangeNativeSocial -authorizeWithOOB -authorizeWithOTP -authorizeWithPasswordRealm -authorizeWithRecoveryCode -authorizeWithSMS -cancelWebAuth -clearCredentials -clearSession -error -getCredentials -hasValidCredentials -isLoading -resetPassword -revokeRefreshToken -sendEmailCode -sendMultifactorChallenge -sendSMSCode -user -

                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                          authorize: (
                                                                                                                                                                                                                                                                                                                                                                              parameters?: WebAuthorizeParameters,
                                                                                                                                                                                                                                                                                                                                                                              options?: WebAuthorizeOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Authorize the user using Auth0 Universal Login. See <a href="../classes/Types.WebAuth.html#authorize" class="tsd-kind-method">WebAuth#authorize</a>

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                          authorizeWithEmail: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: LoginWithEmailOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Authorize the user using an email code. See <a href="../classes/Types.Auth.html#loginwithemail" class="tsd-kind-method">Auth#loginWithEmail</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          authorizeWithExchangeNativeSocial: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: ExchangeNativeSocialOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Authorize user with credentials using the Password Realm Grant. See <a href="../classes/Types.Auth.html#passwordrealm" class="tsd-kind-method">Auth#passwordRealm</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          authorizeWithOOB: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: LoginWithOOBOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Authorize the user using an Out Of Band authentication code. See <a href="../classes/Types.Auth.html#loginwithoob" class="tsd-kind-method">Auth#loginWithOOB</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          authorizeWithOTP: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: LoginWithOTPOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Autohrize the user using a One Time Password code. See <a href="../classes/Types.Auth.html#loginwithotp" class="tsd-kind-method">Auth#loginWithOTP</a>.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          authorizeWithPasswordRealm: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: PasswordRealmOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Authorize user with credentials using the Password Realm Grant. See <a href="../classes/Types.Auth.html#passwordrealm" class="tsd-kind-method">Auth#passwordRealm</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          authorizeWithRecoveryCode: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: LoginWithRecoveryCodeOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Authorize the user using a multi-factor authentication Recovery Code. See <a href="../classes/Types.Auth.html#loginwithrecoverycode" class="tsd-kind-method">Auth#loginWithRecoveryCode</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          authorizeWithSMS: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: LoginWithSMSOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Authorize the user using a SMS code. See <a href="../classes/Types.Auth.html#loginwithsms" class="tsd-kind-method">Auth#loginWithSMS</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          cancelWebAuth: () => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Cancel any ongoing Universal Login transaction. -This works only on iOS and not on any other platforms

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          clearCredentials: () => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Clears the user's credentials without clearing their web session and logs them out.

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          clearSession: (
                                                                                                                                                                                                                                                                                                                                                                              parameters?: ClearSessionParameters,
                                                                                                                                                                                                                                                                                                                                                                              options?: ClearSessionOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Clears the user's web session, credentials and logs them out. See <a href="../classes/Types.WebAuth.html#clearsession" class="tsd-kind-method">WebAuth#clearSession</a>

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                          error: null | BaseError

                                                                                                                                                                                                                                                                                                                                                                          An object representing the last exception

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          getCredentials: (
                                                                                                                                                                                                                                                                                                                                                                              scope?: string,
                                                                                                                                                                                                                                                                                                                                                                              minTtl?: number,
                                                                                                                                                                                                                                                                                                                                                                              parameters?: Record<string, unknown>,
                                                                                                                                                                                                                                                                                                                                                                              forceRefresh?: boolean,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          Gets the user's credentials from the native credential store. If credentials have expired, they are automatically refreshed -by default. See <a href="../classes/Types.CredentialsManager.html#getcredentials" class="tsd-kind-method">CredentialsManager#getCredentials</a>

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                            • (
                                                                                                                                                                                                                                                                                                                                                                                  scope?: string,
                                                                                                                                                                                                                                                                                                                                                                                  minTtl?: number,
                                                                                                                                                                                                                                                                                                                                                                                  parameters?: Record<string, unknown>,
                                                                                                                                                                                                                                                                                                                                                                                  forceRefresh?: boolean,
                                                                                                                                                                                                                                                                                                                                                                              ): Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                              • Optionalscope: string

                                                                                                                                                                                                                                                                                                                                                                                The scopes used to get the credentials

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • OptionalminTtl: number

                                                                                                                                                                                                                                                                                                                                                                                The minimum time in seconds that the access token should last before expiration

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optionalparameters: Record<string, unknown>

                                                                                                                                                                                                                                                                                                                                                                                Any additional parameters to send in the request to refresh expired credentials.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • OptionalforceRefresh: boolean

                                                                                                                                                                                                                                                                                                                                                                                If true, credentials are always refreshed regardless of their expiry, provided a valid refresh token is available.

                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<undefined | Credentials>

                                                                                                                                                                                                                                                                                                                                                                          hasValidCredentials: (minTtl?: number) => Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                          Whether the SDK currently holds valid, unexpired credentials.

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                            • (minTtl?: number): Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                                              • OptionalminTtl: number

                                                                                                                                                                                                                                                                                                                                                                                The minimum time in seconds that the access token should last before expiration

                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                              Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                                              true if there are valid credentials. Otherwise, false.

                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                          isLoading: boolean

                                                                                                                                                                                                                                                                                                                                                                          A flag that is true until the state knows that a user is either logged in or not

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          resetPassword: (parameters: ResetPasswordOptions) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Request an email with instructions to change password of a user <a href="../classes/Types.Auth.html#resetpassword" class="tsd-kind-method">Auth#resetPassword</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          revokeRefreshToken: (parameters: RevokeOptions) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Revokes an issued refresh token. See <a href="../classes/Types.Auth.html#revoke" class="tsd-kind-method">Auth#revoke</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          sendEmailCode: (parameters: PasswordlessWithEmailOptions) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Start the passwordless email login flow. See <a href="../classes/Types.Auth.html#passwordlesswithemail" class="tsd-kind-method">Auth#passwordlessWithEmail</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          sendMultifactorChallenge: (
                                                                                                                                                                                                                                                                                                                                                                              parameters: MultifactorChallengeOptions,
                                                                                                                                                                                                                                                                                                                                                                          ) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Send a challenge for multi-factor authentication. See <a href="../classes/Types.Auth.html#multifactorchallenge" class="tsd-kind-method">Auth#multifactorChallenge</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          sendSMSCode: (parameters: PasswordlessWithSMSOptions) => Promise<void>

                                                                                                                                                                                                                                                                                                                                                                          Start the passwordless SMS login flow. See <a href="../classes/Types.Auth.html#passwordlesswithsms" class="tsd-kind-method">Auth#passwordlessWithSMS</a>

                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                          user: null | TUser

                                                                                                                                                                                                                                                                                                                                                                          The user profile as decoded from the ID token after authentication

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                          + + + + + + Auth0ContextInterface | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                            Interface Auth0ContextInterface<TUser>

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + interface + Auth0ContextInterface<TUser + extends + User + = + User> + {
                                                                                                                                                                                                                                                                                                                                                                                authorize: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters?: + WebAuthorizeParameters,
                                                                                                                                                                                                                                                                                                                                                                                    options?: + WebAuthorizeOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                authorizeWithEmail: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + LoginWithEmailOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                authorizeWithExchangeNativeSocial: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + ExchangeNativeSocialOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                authorizeWithOOB: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + LoginWithOOBOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                authorizeWithOTP: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + LoginWithOTPOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                authorizeWithPasswordRealm: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + PasswordRealmOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                authorizeWithRecoveryCode: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + LoginWithRecoveryCodeOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                authorizeWithSMS: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + LoginWithSMSOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                cancelWebAuth: + () + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                clearCredentials: + () + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                clearSession: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters?: + ClearSessionParameters,
                                                                                                                                                                                                                                                                                                                                                                                    options?: + ClearSessionOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                error: + null + | + BaseError;
                                                                                                                                                                                                                                                                                                                                                                                getCredentials: + (
                                                                                                                                                                                                                                                                                                                                                                                    scope?: + string,
                                                                                                                                                                                                                                                                                                                                                                                    minTtl?: + number,
                                                                                                                                                                                                                                                                                                                                                                                    parameters?: + Record<string, + unknown>,
                                                                                                                                                                                                                                                                                                                                                                                    forceRefresh?: + boolean,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<undefined + | + Credentials>;
                                                                                                                                                                                                                                                                                                                                                                                hasValidCredentials: + (minTtl?: + number) + => + Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                                                isLoading: + boolean;
                                                                                                                                                                                                                                                                                                                                                                                resetPassword: + (parameters: + ResetPasswordOptions) + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                revokeRefreshToken: + (parameters: + RevokeOptions) + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                sendEmailCode: + (parameters: + PasswordlessWithEmailOptions) + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                sendMultifactorChallenge: + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters: + MultifactorChallengeOptions,
                                                                                                                                                                                                                                                                                                                                                                                ) + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                sendSMSCode: + (parameters: + PasswordlessWithSMSOptions) + => + Promise<void>;
                                                                                                                                                                                                                                                                                                                                                                                user: + null + | + TUser;
                                                                                                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type Parameters

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • + TUser + extends + User + = + User +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Hierarchy (View Summary) +

                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + authorize + + authorizeWithEmail + + authorizeWithExchangeNativeSocial + + authorizeWithOOB + + authorizeWithOTP + + authorizeWithPasswordRealm + + authorizeWithRecoveryCode + + authorizeWithSMS + + cancelWebAuth + + clearCredentials + + clearSession + + error + + getCredentials + + hasValidCredentials + + isLoading + + resetPassword + + revokeRefreshToken + + sendEmailCode + + sendMultifactorChallenge + + sendSMSCode + + user +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorize: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters?: + WebAuthorizeParameters,
                                                                                                                                                                                                                                                                                                                                                                                options?: + WebAuthorizeOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Authorize the user using Auth0 Universal Login. See <a + href="../classes/Types.WebAuth.html#authorize" + class="tsd-kind-method">WebAuth#authorize</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorizeWithEmail: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + LoginWithEmailOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Authorize the user using an email code. See <a + href="../classes/Types.Auth.html#loginwithemail" + class="tsd-kind-method">Auth#loginWithEmail</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorizeWithExchangeNativeSocial: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + ExchangeNativeSocialOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Authorize user with credentials using the Password Realm + Grant. See <a + href="../classes/Types.Auth.html#passwordrealm" + class="tsd-kind-method">Auth#passwordRealm</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorizeWithOOB: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + LoginWithOOBOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Authorize the user using an Out Of Band authentication code. + See <a + href="../classes/Types.Auth.html#loginwithoob" + class="tsd-kind-method">Auth#loginWithOOB</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorizeWithOTP: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + LoginWithOTPOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Autohrize the user using a One Time Password code. See <a + href="../classes/Types.Auth.html#loginwithotp" + class="tsd-kind-method">Auth#loginWithOTP</a>. +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorizeWithPasswordRealm: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + PasswordRealmOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Authorize user with credentials using the Password Realm + Grant. See <a + href="../classes/Types.Auth.html#passwordrealm" + class="tsd-kind-method">Auth#passwordRealm</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorizeWithRecoveryCode: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + LoginWithRecoveryCodeOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Authorize the user using a multi-factor authentication + Recovery Code. See <a + href="../classes/Types.Auth.html#loginwithrecoverycode" + class="tsd-kind-method">Auth#loginWithRecoveryCode</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + authorizeWithSMS: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + LoginWithSMSOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Authorize the user using a SMS code. See <a + href="../classes/Types.Auth.html#loginwithsms" + class="tsd-kind-method">Auth#loginWithSMS</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + cancelWebAuth: + () + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Cancel any ongoing Universal Login transaction. This works + only on iOS and not on any other platforms +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + clearCredentials: + () + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Clears the user's credentials without clearing their web + session and logs them out. +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + clearSession: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters?: + ClearSessionParameters,
                                                                                                                                                                                                                                                                                                                                                                                options?: + ClearSessionOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Clears the user's web session, credentials and logs them out. + See <a + href="../classes/Types.WebAuth.html#clearsession" + class="tsd-kind-method">WebAuth#clearSession</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • + (
                                                                                                                                                                                                                                                                                                                                                                                    parameters?: + ClearSessionParameters,
                                                                                                                                                                                                                                                                                                                                                                                    options?: + ClearSessionOptions,
                                                                                                                                                                                                                                                                                                                                                                                ): + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                • + Optionalparameters: + ClearSessionParameters +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  + Additional parameters to send to the Auth0 + logout endpoint. +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • + Optionaloptions: + ClearSessionOptions +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  + Options for configuring the SDK's clear + session behaviour. +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + Returns Promise<void> +

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + error: + null + | + BaseError +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            An object representing the last exception

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + getCredentials: + (
                                                                                                                                                                                                                                                                                                                                                                                scope?: + string,
                                                                                                                                                                                                                                                                                                                                                                                minTtl?: + number,
                                                                                                                                                                                                                                                                                                                                                                                parameters?: + Record<string, + unknown>,
                                                                                                                                                                                                                                                                                                                                                                                forceRefresh?: + boolean,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Gets the user's credentials from the native credential store. + If credentials have expired, they are automatically refreshed + by default. See <a + href="../classes/Types.CredentialsManager.html#getcredentials" + class="tsd-kind-method">CredentialsManager#getCredentials</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • + (
                                                                                                                                                                                                                                                                                                                                                                                    scope?: + string,
                                                                                                                                                                                                                                                                                                                                                                                    minTtl?: + number,
                                                                                                                                                                                                                                                                                                                                                                                    parameters?: + Record<string, + unknown>,
                                                                                                                                                                                                                                                                                                                                                                                    forceRefresh?: + boolean,
                                                                                                                                                                                                                                                                                                                                                                                ): + Promise<undefined + | + Credentials> +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                • + Optionalscope: + string +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  The scopes used to get the credentials

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • + OptionalminTtl: + number +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  + The minimum time in seconds that the access + token should last before expiration +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • + Optionalparameters: Record<string, + unknown> +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  + Any additional parameters to send in the + request to refresh expired credentials. +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • + OptionalforceRefresh: + boolean +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  + If true, credentials are always + refreshed regardless of their expiry, provided + a valid refresh token is available. +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + Returns Promise<undefined + | + Credentials> +

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + hasValidCredentials: + (minTtl?: + number) + => + Promise<boolean> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Whether the SDK currently holds valid, unexpired credentials. +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • + (minTtl?: + number): + Promise<boolean> +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                • + OptionalminTtl: + number +
                                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                                  + The minimum time in seconds that the access + token should last before expiration +

                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + Returns Promise<boolean> +

                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + true if there are valid credentials. + Otherwise, false. +

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                • +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + isLoading: + boolean +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + A flag that is true until the state knows that a user is + either logged in or not +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + resetPassword: + (parameters: + ResetPasswordOptions) + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Request an email with instructions to change password of a + user <a + href="../classes/Types.Auth.html#resetpassword" + class="tsd-kind-method">Auth#resetPassword</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + revokeRefreshToken: + (parameters: + RevokeOptions) + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Revokes an issued refresh token. See <a + href="../classes/Types.Auth.html#revoke" + class="tsd-kind-method">Auth#revoke</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + sendEmailCode: + (parameters: + PasswordlessWithEmailOptions) + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Start the passwordless email login flow. See <a + href="../classes/Types.Auth.html#passwordlesswithemail" + class="tsd-kind-method">Auth#passwordlessWithEmail</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + sendMultifactorChallenge: + (
                                                                                                                                                                                                                                                                                                                                                                                parameters: + MultifactorChallengeOptions,
                                                                                                                                                                                                                                                                                                                                                                            ) + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Send a challenge for multi-factor authentication. See <a + href="../classes/Types.Auth.html#multifactorchallenge" + class="tsd-kind-method">Auth#multifactorChallenge</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + sendSMSCode: + (parameters: + PasswordlessWithSMSOptions) + => + Promise<void> +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Start the passwordless SMS login flow. See <a + href="../classes/Types.Auth.html#passwordlesswithsms" + class="tsd-kind-method">Auth#passwordlessWithSMS</a> +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            + user: + null + | + TUser +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + The user profile as decoded from the ID token after + authentication +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/interfaces/Types.AuthState.html b/docs/interfaces/Types.AuthState.html index ad779616..63bf1ade 100644 --- a/docs/interfaces/Types.AuthState.html +++ b/docs/interfaces/Types.AuthState.html @@ -1,7 +1,549 @@ -AuthState | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                              Interface AuthState<TUser>

                                                                                                                                                                                                                                                                                                                                                                              interface AuthState<TUser extends User = User> {
                                                                                                                                                                                                                                                                                                                                                                                  error: null | BaseError;
                                                                                                                                                                                                                                                                                                                                                                                  isLoading: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  user: null | TUser;
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                              Hierarchy (View Summary)

                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              error -isLoading -user -

                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                              error: null | BaseError

                                                                                                                                                                                                                                                                                                                                                                              An object representing the last exception

                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                              isLoading: boolean

                                                                                                                                                                                                                                                                                                                                                                              A flag that is true until the state knows that a user is either logged in or not

                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                              user: null | TUser

                                                                                                                                                                                                                                                                                                                                                                              The user profile as decoded from the ID token after authentication

                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                              + + + + + + AuthState | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                Interface AuthState<TUser>

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + interface + AuthState<TUser + extends + User + = + User> + {
                                                                                                                                                                                                                                                                                                                                                                                    error: + null + | + BaseError;
                                                                                                                                                                                                                                                                                                                                                                                    isLoading: + boolean;
                                                                                                                                                                                                                                                                                                                                                                                    user: + null + | + TUser;
                                                                                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                • + TUser + extends + User + = + User +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + Hierarchy (View Summary) +

                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + error + + isLoading + + user +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                + error: + null + | + BaseError +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                An object representing the last exception

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                + isLoading: + boolean +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + A flag that is true until the state knows that a user is + either logged in or not +

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                + user: + null + | + TUser +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + The user profile as decoded from the ID token after + authentication +

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                + + diff --git a/docs/interfaces/UserInfoOptions.html b/docs/interfaces/UserInfoOptions.html index c862f2a3..70584cd1 100644 --- a/docs/interfaces/UserInfoOptions.html +++ b/docs/interfaces/UserInfoOptions.html @@ -1,6 +1,427 @@ -UserInfoOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                  Interface UserInfoOptions

                                                                                                                                                                                                                                                                                                                                                                                  Options for accessing the /userinfo endpoint.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  interface UserInfoOptions {
                                                                                                                                                                                                                                                                                                                                                                                      headers?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                                      token: string;
                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  headers? -token -

                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                  headers?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                                  (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                  token: string

                                                                                                                                                                                                                                                                                                                                                                                  The user's access token

                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + UserInfoOptions | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                    Interface UserInfoOptions

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Options for accessing the /userinfo endpoint.

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + interface + UserInfoOptions + {
                                                                                                                                                                                                                                                                                                                                                                                        headers?: + Record<string, + string>;
                                                                                                                                                                                                                                                                                                                                                                                        token: + string;
                                                                                                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + headers? + + token +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    + headers?: + Record<string, + string> +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    (Optional) Custom headers to include in the request.

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    + token: + string +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    The user's access token

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/interfaces/WebAuthorizeOptions.html b/docs/interfaces/WebAuthorizeOptions.html index dcf1b07d..53d70de7 100644 --- a/docs/interfaces/WebAuthorizeOptions.html +++ b/docs/interfaces/WebAuthorizeOptions.html @@ -1,22 +1,705 @@ -WebAuthorizeOptions | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                      Interface WebAuthorizeOptions

                                                                                                                                                                                                                                                                                                                                                                                      Options for controlling the SDK's behaviour when calling the /authorize endpoint.

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      interface WebAuthorizeOptions {
                                                                                                                                                                                                                                                                                                                                                                                          customScheme?: string;
                                                                                                                                                                                                                                                                                                                                                                                          ephemeralSession?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                          leeway?: number;
                                                                                                                                                                                                                                                                                                                                                                                          useLegacyCallbackUrl?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                          useSFSafariViewController?:
                                                                                                                                                                                                                                                                                                                                                                                              | boolean
                                                                                                                                                                                                                                                                                                                                                                                              | { presentationStyle?: SafariViewControllerPresentationStyle };
                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      customScheme? -ephemeralSession? -leeway? -useLegacyCallbackUrl? -useSFSafariViewController? -

                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                      customScheme?: string

                                                                                                                                                                                                                                                                                                                                                                                      Custom scheme to build the callback URL with.

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      ephemeralSession?: boolean

                                                                                                                                                                                                                                                                                                                                                                                      iOS only: Disable Single-Sign-On (SSO). It only affects iOS with versions 13 and above.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      false

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      leeway?: number

                                                                                                                                                                                                                                                                                                                                                                                      The amount of leeway, in seconds, to accommodate potential clock skew when validating an ID token's claims.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      60 seconds.

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      useLegacyCallbackUrl?: boolean

                                                                                                                                                                                                                                                                                                                                                                                      This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details.

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      useSFSafariViewController?:
                                                                                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                                                                                          | { presentationStyle?: SafariViewControllerPresentationStyle }

                                                                                                                                                                                                                                                                                                                                                                                      iOS only: Uses SFSafariViewController instead of ASWebAuthenticationSession. If empty object is set, the presentationStyle defaults to <a href="../enums/SafariViewControllerPresentationStyle.html#fullscreen" class="tsd-kind-enum-member">SafariViewControllerPresentationStyle.fullScreen</a>

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      This can be used as a boolean value or as an object which sets the presentationStyle. See the examples below for reference

                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                      await authorize({}, {useSFSafariViewController: true});
+
+
+  
+    
+    
+    WebAuthorizeOptions | react-native-auth0
+    
+    
+    
+    
+    
+    
+    
+    
+    
+  
+  
+    
+    
                                                                                                                                                                                                                                                                                                                                                                                      
+      
                                                                                                                                                                                                                                                                                                                                                                                      
+        react-native-auth0
+        
+        
+        
+          
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                                                                                                                                                                
+        
+      
                                                                                                                                                                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                                                                                                                                                                        
+    
                                                                                                                                                                                                                                                                                                                                                                                        
+      
                                                                                                                                                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+          
+          
                                                                                                                                                                                                                                                                                                                                                                                        Interface WebAuthorizeOptions
                                                                                                                                                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+              Options for controlling the SDK's behaviour when calling the
+              /authorize endpoint.
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+          interface
+          WebAuthorizeOptions
+          {
                                                                                                                                                                                                                                                                                                                                                                                            customScheme?:
+          string;
                                                                                                                                                                                                                                                                                                                                                                                            ephemeralSession?:
+          boolean;
                                                                                                                                                                                                                                                                                                                                                                                            leeway?:
+          number;
                                                                                                                                                                                                                                                                                                                                                                                            useLegacyCallbackUrl?:
+          boolean;
                                                                                                                                                                                                                                                                                                                                                                                            useSFSafariViewController?:
                                                                                                                                                                                                                                                                                                                                                                                                |
+          boolean
                                                                                                                                                                                                                                                                                                                                                                                                |
+          {
+          presentationStyle?:
+          SafariViewControllerPresentationStyle
+          };
                                                                                                                                                                                                                                                                                                                                                                                        }
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+                
+                
                                                                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                                                                                                                                                                      
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  
                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                        
+                  
                                                                                                                                                                                                                                                                                                                                                                                        
+                    
+                        customScheme?
+                    
+                        ephemeralSession?
+                    
+                        leeway?
+                    
+                        useLegacyCallbackUrl?
+                    
+                        useSFSafariViewController?
+                  
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+        
                                                                                                                                                                                                                                                                                                                                                                                        
+          
+            
+            
                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                        
+                                                                                                                                                                                                                                                                                                                                                                                                  
+          
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                customScheme?:
+                string
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        Custom scheme to build the callback URL with.
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                ephemeralSession?:
+                boolean
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  iOS only: Disable Single-Sign-On (SSO). It
+                  only affects iOS with versions 13 and above.
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  
+                  
                                                                                                                                                                                                                                                                                                                                                                                        false
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                leeway?:
+                number
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  The amount of leeway, in seconds, to accommodate potential
+                  clock skew when validating an ID token's claims.
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  
+                  
                                                                                                                                                                                                                                                                                                                                                                                        60 seconds.
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                useLegacyCallbackUrl?:
+                boolean
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  This will use older callback URL. See <a href="https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration">https://github.com/auth0/react-native-auth0/blob/master/MIGRATION_GUIDE.md#callback-url-migration&lt;/a&gt; for more details.
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+            
                                                                                                                                                                                                                                                                                                                                                                                        
+              
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                useSFSafariViewController?:
                                                                                                                                                                                                                                                                                                                                                                                            |
+                boolean
                                                                                                                                                                                                                                                                                                                                                                                            |
+                {
+                presentationStyle?:
+                SafariViewControllerPresentationStyle
+                }
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  iOS only: Uses
+                  SFSafariViewController instead of
+                  ASWebAuthenticationSession. If empty object is
+                  set, the presentationStyle defaults to <a
+                  href="../enums/SafariViewControllerPresentationStyle.html#fullscreen"
+                  class="tsd-kind-enum-member">SafariViewControllerPresentationStyle.fullScreen</a>
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  This can be used as a boolean value or as an object which sets
+                  the presentationStyle. See the examples below for
+                  reference
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+              
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  
+                  
                                                                                                                                                                                                                                                                                                                                                                                        await authorize({}, {useSFSafariViewController: true});
 
                                                                                                                                                                                                                                                                                                                                                                                        
 
-
                                                                                                                                                                                                                                                                                                                                                                                        or
                                                                                                                                                                                                                                                                                                                                                                                        
-
                                                                                                                                                                                                                                                                                                                                                                                        await authorize({}, {useSFSafariViewController: {presentationStyle: SafariViewControllerPresentationStyle.fullScreen}});
+                  
                                                                                                                                                                                                                                                                                                                                                                                        or
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                
                                                                                                                                                                                                                                                                                                                                                                                        
+                  
+                  
                                                                                                                                                                                                                                                                                                                                                                                        await authorize({}, {useSFSafariViewController: {presentationStyle: SafariViewControllerPresentationStyle.fullScreen}});
 
                                                                                                                                                                                                                                                                                                                                                                                        
-
-
                                                                                                                                                                                                                                                                                                                                                                                        Settings
                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                        On This Page
                                                                                                                                                                                                                                                                                                                                                                                        Properties
                                                                                                                                                                                                                                                                                                                                                                                        
+
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/interfaces/WebAuthorizeParameters.html b/docs/interfaces/WebAuthorizeParameters.html index fff07b29..27d7ad9c 100644 --- a/docs/interfaces/WebAuthorizeParameters.html +++ b/docs/interfaces/WebAuthorizeParameters.html @@ -1,28 +1,907 @@ -WebAuthorizeParameters | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                          Interface WebAuthorizeParameters

                                                                                                                                                                                                                                                                                                                                                                                          Parameters that are sent to a call to the /authorize endpoint.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          interface WebAuthorizeParameters {
                                                                                                                                                                                                                                                                                                                                                                                              additionalParameters?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                                                              audience?: string;
                                                                                                                                                                                                                                                                                                                                                                                              connection?: string;
                                                                                                                                                                                                                                                                                                                                                                                              invitationUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                              maxAge?: number;
                                                                                                                                                                                                                                                                                                                                                                                              nonce?: string;
                                                                                                                                                                                                                                                                                                                                                                                              organization?: string;
                                                                                                                                                                                                                                                                                                                                                                                              redirectUrl?: string;
                                                                                                                                                                                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                              state?: string;
                                                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          additionalParameters? -audience? -connection? -invitationUrl? -maxAge? -nonce? -organization? -redirectUrl? -scope? -state? -

                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                          additionalParameters?: { [key: string]: string }

                                                                                                                                                                                                                                                                                                                                                                                          Any additional arbitrary parameters to send along in the URL.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          audience?: string

                                                                                                                                                                                                                                                                                                                                                                                          The intended API identifier that will be the consumer for the issued access token.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          connection?: string

                                                                                                                                                                                                                                                                                                                                                                                          The database connection in which to look for users.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          invitationUrl?: string

                                                                                                                                                                                                                                                                                                                                                                                          The invitation URL for those users who have been invited to join a specific organization.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          maxAge?: number

                                                                                                                                                                                                                                                                                                                                                                                          The maximum age in seconds that the resulting ID token should be issued for.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          nonce?: string

                                                                                                                                                                                                                                                                                                                                                                                          One-time random value that is used to prevent replay attacks.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          organization?: string

                                                                                                                                                                                                                                                                                                                                                                                          The organization in which user's should be authenticated into.

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          redirectUrl?: string

                                                                                                                                                                                                                                                                                                                                                                                          Specify a custom redirect URL to be used. Normally, you wouldn't need to call this method manually as the default value is autogenerated for you.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          If you are using this, ensure a proper redirect URL is constructed in the following format -Android: {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -iOS: {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          If you have useLegacyCallbackUrl set to true then the redirect URL should in the format -Android: {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback -iOS: {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          scope?: string

                                                                                                                                                                                                                                                                                                                                                                                          The scopes requested for the issued tokens. e.g. openid profile

                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                          state?: string

                                                                                                                                                                                                                                                                                                                                                                                          Random string to prevent CSRF attacks.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + WebAuthorizeParameters | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                            Interface WebAuthorizeParameters

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + Parameters that are sent to a call to the + /authorize endpoint. +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + interface + WebAuthorizeParameters + {
                                                                                                                                                                                                                                                                                                                                                                                                additionalParameters?: + { + [key: + string]: + string + };
                                                                                                                                                                                                                                                                                                                                                                                                audience?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                connection?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                invitationUrl?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                maxAge?: + number;
                                                                                                                                                                                                                                                                                                                                                                                                nonce?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                organization?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                redirectUrl?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                scope?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                state?: + string;
                                                                                                                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + +
                                                                                                                                                                                                                                                                                                                                                                                            Index
                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + additionalParameters? + + audience? + + connection? + + invitationUrl? + + maxAge? + + nonce? + + organization? + + redirectUrl? + + scope? + + state? +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + additionalParameters?: + { + [key: + string]: + string + } +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + Any additional arbitrary parameters to send along in the URL. +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + audience?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + The intended API identifier that will be the consumer for the + issued access token. +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + connection?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            The database connection in which to look for users.

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + invitationUrl?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + The invitation URL for those users who have been invited to + join a specific organization. +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + maxAge?: + number +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + The maximum age in seconds that the resulting ID token should + be issued for. +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + nonce?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + One-time random value that is used to prevent replay attacks. +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + organization?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + The organization in which user's should be authenticated into. +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + redirectUrl?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + Specify a custom redirect URL to be used. Normally, you + wouldn't need to call this method manually as the default + value is autogenerated for you. +

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + If you are using this, ensure a proper redirect URL is + constructed in the following format Android: + {YOUR_APP_PACKAGE_NAME}.auth0://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback + iOS: + {PRODUCT_BUNDLE_IDENTIFIER}.auth0://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback +

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + If you have useLegacyCallbackUrl set to true then + the redirect URL should in the format Android: + {YOUR_APP_PACKAGE_NAME}://{AUTH0_DOMAIN}/android/{YOUR_APP_PACKAGE_NAME}/callback + iOS: + {PRODUCT_BUNDLE_IDENTIFIER}://{AUTH0_DOMAIN}/ios/{PRODUCT_BUNDLE_IDENTIFIER}/callback +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + scope?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + The scopes requested for the issued tokens. e.g. + openid profile +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            + state?: + string +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Random string to prevent CSRF attacks.

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/modules.html b/docs/modules.html index c92ba012..d451018a 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1 +1,1511 @@ -react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                react-native-auth0

                                                                                                                                                                                                                                                                                                                                                                                                Modules

                                                                                                                                                                                                                                                                                                                                                                                                Types

                                                                                                                                                                                                                                                                                                                                                                                                Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                LocalAuthenticationLevel
                                                                                                                                                                                                                                                                                                                                                                                                LocalAuthenticationStrategy
                                                                                                                                                                                                                                                                                                                                                                                                SafariViewControllerPresentationStyle

                                                                                                                                                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                                                                                                                                                default
                                                                                                                                                                                                                                                                                                                                                                                                TimeoutError

                                                                                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                Auth0Options
                                                                                                                                                                                                                                                                                                                                                                                                AuthorizeUrlOptions
                                                                                                                                                                                                                                                                                                                                                                                                ClearSessionOptions
                                                                                                                                                                                                                                                                                                                                                                                                ClearSessionParameters
                                                                                                                                                                                                                                                                                                                                                                                                CreateUserOptions
                                                                                                                                                                                                                                                                                                                                                                                                ExchangeNativeSocialOptions
                                                                                                                                                                                                                                                                                                                                                                                                ExchangeOptions
                                                                                                                                                                                                                                                                                                                                                                                                GetUserOptions
                                                                                                                                                                                                                                                                                                                                                                                                LocalAuthenticationOptions
                                                                                                                                                                                                                                                                                                                                                                                                LoginWithEmailOptions
                                                                                                                                                                                                                                                                                                                                                                                                LoginWithOOBOptions
                                                                                                                                                                                                                                                                                                                                                                                                LoginWithOTPOptions
                                                                                                                                                                                                                                                                                                                                                                                                LoginWithRecoveryCodeOptions
                                                                                                                                                                                                                                                                                                                                                                                                LoginWithSMSOptions
                                                                                                                                                                                                                                                                                                                                                                                                LogoutUrlOptions
                                                                                                                                                                                                                                                                                                                                                                                                MultifactorChallengeOptions
                                                                                                                                                                                                                                                                                                                                                                                                PasswordlessWithEmailOptions
                                                                                                                                                                                                                                                                                                                                                                                                PasswordlessWithSMSOptions
                                                                                                                                                                                                                                                                                                                                                                                                PasswordRealmOptions
                                                                                                                                                                                                                                                                                                                                                                                                PatchUserOptions
                                                                                                                                                                                                                                                                                                                                                                                                RefreshTokenOptions
                                                                                                                                                                                                                                                                                                                                                                                                ResetPasswordOptions
                                                                                                                                                                                                                                                                                                                                                                                                RevokeOptions
                                                                                                                                                                                                                                                                                                                                                                                                UserInfoOptions
                                                                                                                                                                                                                                                                                                                                                                                                WebAuthorizeOptions
                                                                                                                                                                                                                                                                                                                                                                                                WebAuthorizeParameters

                                                                                                                                                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                Credentials
                                                                                                                                                                                                                                                                                                                                                                                                MultifactorChallengeOOBResponse
                                                                                                                                                                                                                                                                                                                                                                                                MultifactorChallengeOOBWithBindingResponse
                                                                                                                                                                                                                                                                                                                                                                                                MultifactorChallengeOTPResponse
                                                                                                                                                                                                                                                                                                                                                                                                MultifactorChallengeResponse
                                                                                                                                                                                                                                                                                                                                                                                                User

                                                                                                                                                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                                                                                                                                                Auth0Provider
                                                                                                                                                                                                                                                                                                                                                                                                useAuth0

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                Modules
                                                                                                                                                                                                                                                                                                                                                                                                Enumerations
                                                                                                                                                                                                                                                                                                                                                                                                Classes
                                                                                                                                                                                                                                                                                                                                                                                                Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                Functions
                                                                                                                                                                                                                                                                                                                                                                                                + + + + + + react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +                                                                                                                                                                                                                                                                                                                                                                                                   + +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    react-native-auth0

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Modules

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Types +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Enumerations

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LocalAuthenticationLevel +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LocalAuthenticationStrategy +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + SafariViewControllerPresentationStyle +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + default +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + TimeoutError +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Auth0Options +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + AuthorizeUrlOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + ClearSessionOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + ClearSessionParameters +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + CreateUserOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + ExchangeNativeSocialOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + ExchangeOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + GetUserOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LocalAuthenticationOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LoginWithEmailOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LoginWithOOBOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LoginWithOTPOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LoginWithRecoveryCodeOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LoginWithSMSOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + LogoutUrlOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + MultifactorChallengeOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + PasswordlessWithEmailOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + PasswordlessWithSMSOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + PasswordRealmOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + PatchUserOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + RefreshTokenOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + ResetPasswordOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + RevokeOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + UserInfoOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + WebAuthorizeOptions +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + WebAuthorizeParameters +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Credentials +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + MultifactorChallengeOOBResponse +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + MultifactorChallengeOOBWithBindingResponse +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + MultifactorChallengeOTPResponse +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + MultifactorChallengeResponse +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + User +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Functions

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Auth0Provider +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + useAuth0 +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Modules + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Enumerations + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Classes + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Interfaces + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Type Aliases + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + Functions + + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/modules/Types.html b/docs/modules/Types.html index 059e1fdf..675e86b9 100644 --- a/docs/modules/Types.html +++ b/docs/modules/Types.html @@ -1 +1,563 @@ -Types | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                      Module Types

                                                                                                                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                                                                                                                      Auth
                                                                                                                                                                                                                                                                                                                                                                                                      BaseError
                                                                                                                                                                                                                                                                                                                                                                                                      CredentialsManager
                                                                                                                                                                                                                                                                                                                                                                                                      Users
                                                                                                                                                                                                                                                                                                                                                                                                      WebAuth

                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                      Auth0ContextInterface
                                                                                                                                                                                                                                                                                                                                                                                                      AuthState

                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                      Auth0Response
                                                                                                                                                                                                                                                                                                                                                                                                      Telemetry

                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + Types | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                        Module Types

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Auth +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + BaseError +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + CredentialsManager +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Users +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + WebAuth +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Auth0ContextInterface +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + AuthState +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Auth0Response +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Telemetry +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Classes + + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Interfaces + + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + Type Aliases + + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/types/Credentials.html b/docs/types/Credentials.html index bdf93257..adb5ac21 100644 --- a/docs/types/Credentials.html +++ b/docs/types/Credentials.html @@ -1,13 +1,657 @@ -Credentials | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Credentials

                                                                                                                                                                                                                                                                                                                                                                                                          type Credentials = {
                                                                                                                                                                                                                                                                                                                                                                                                              accessToken: string;
                                                                                                                                                                                                                                                                                                                                                                                                              expiresAt: number;
                                                                                                                                                                                                                                                                                                                                                                                                              idToken: string;
                                                                                                                                                                                                                                                                                                                                                                                                              refreshToken?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              scope?: string;
                                                                                                                                                                                                                                                                                                                                                                                                              tokenType: string;
                                                                                                                                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                                          Indexable

                                                                                                                                                                                                                                                                                                                                                                                                          • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                          Index

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          accessToken -expiresAt -idToken -refreshToken? -scope? -tokenType -

                                                                                                                                                                                                                                                                                                                                                                                                          Properties

                                                                                                                                                                                                                                                                                                                                                                                                          accessToken: string

                                                                                                                                                                                                                                                                                                                                                                                                          The token used to make API calls

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          expiresAt: number

                                                                                                                                                                                                                                                                                                                                                                                                          Used to denote when the token will expire, as a UNIX timestamp

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          idToken: string

                                                                                                                                                                                                                                                                                                                                                                                                          A token in JWT format that has user claims

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          refreshToken?: string

                                                                                                                                                                                                                                                                                                                                                                                                          The token used to refresh the access token

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          scope?: string

                                                                                                                                                                                                                                                                                                                                                                                                          Represents the scope of the current token

                                                                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                                                                          tokenType: string

                                                                                                                                                                                                                                                                                                                                                                                                          The type of the token, e.g.: Bearer

                                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                                                                                                                                          Properties
                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + Credentials | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Credentials

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + type + Credentials + = + {
                                                                                                                                                                                                                                                                                                                                                                                                                accessToken: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                expiresAt: + number;
                                                                                                                                                                                                                                                                                                                                                                                                                idToken: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                refreshToken?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                scope?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                tokenType: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                                                                            } +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + accessToken + + expiresAt + + idToken + + refreshToken? + + scope? + + tokenType +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                            Properties

                                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            + accessToken: + string +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            The token used to make API calls

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            + expiresAt: + number +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            + Used to denote when the token will expire, as a UNIX timestamp +

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            + idToken: + string +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            A token in JWT format that has user claims

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            + refreshToken?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            The token used to refresh the access token

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            + scope?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            Represents the scope of the current token

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            + tokenType: + string +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            The type of the token, e.g.: Bearer

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/types/MultifactorChallengeOOBResponse.html b/docs/types/MultifactorChallengeOOBResponse.html index 55c002ce..824cabab 100644 --- a/docs/types/MultifactorChallengeOOBResponse.html +++ b/docs/types/MultifactorChallengeOOBResponse.html @@ -1 +1,242 @@ -MultifactorChallengeOOBResponse | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias MultifactorChallengeOOBResponse

                                                                                                                                                                                                                                                                                                                                                                                                              MultifactorChallengeOOBResponse: MultifactorChallengeOTPResponse & {
                                                                                                                                                                                                                                                                                                                                                                                                                  oobCode: string;
                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + MultifactorChallengeOOBResponse | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias MultifactorChallengeOOBResponse

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + MultifactorChallengeOOBResponse: + MultifactorChallengeOTPResponse + & + {
                                                                                                                                                                                                                                                                                                                                                                                                                    oobCode: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                + + diff --git a/docs/types/MultifactorChallengeOOBWithBindingResponse.html b/docs/types/MultifactorChallengeOOBWithBindingResponse.html index 7fd6ae0c..5568d196 100644 --- a/docs/types/MultifactorChallengeOOBWithBindingResponse.html +++ b/docs/types/MultifactorChallengeOOBWithBindingResponse.html @@ -1 +1,246 @@ -MultifactorChallengeOOBWithBindingResponse | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias MultifactorChallengeOOBWithBindingResponse

                                                                                                                                                                                                                                                                                                                                                                                                                  MultifactorChallengeOOBWithBindingResponse: MultifactorChallengeOOBResponse & {
                                                                                                                                                                                                                                                                                                                                                                                                                      bindingMethod: string;
                                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + + MultifactorChallengeOOBWithBindingResponse | react-native-auth0 + + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias MultifactorChallengeOOBWithBindingResponse

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + MultifactorChallengeOOBWithBindingResponse: + MultifactorChallengeOOBResponse + & + {
                                                                                                                                                                                                                                                                                                                                                                                                                        bindingMethod: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/types/MultifactorChallengeOTPResponse.html b/docs/types/MultifactorChallengeOTPResponse.html index dbfa8002..7882b135 100644 --- a/docs/types/MultifactorChallengeOTPResponse.html +++ b/docs/types/MultifactorChallengeOTPResponse.html @@ -1,2 +1,360 @@ -MultifactorChallengeOTPResponse | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias MultifactorChallengeOTPResponse

                                                                                                                                                                                                                                                                                                                                                                                                                      type MultifactorChallengeOTPResponse = {
                                                                                                                                                                                                                                                                                                                                                                                                                          challengeType: string;
                                                                                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      challengeType -

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                      challengeType: string

                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + MultifactorChallengeOTPResponse | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias MultifactorChallengeOTPResponse

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + type + MultifactorChallengeOTPResponse + = + {
                                                                                                                                                                                                                                                                                                                                                                                                                            challengeType: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        Index
                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + challengeType +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        + challengeType: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                        + + diff --git a/docs/types/MultifactorChallengeResponse.html b/docs/types/MultifactorChallengeResponse.html index 1d9ed8c0..73383bc8 100644 --- a/docs/types/MultifactorChallengeResponse.html +++ b/docs/types/MultifactorChallengeResponse.html @@ -1 +1,244 @@ -MultifactorChallengeResponse | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                        react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                          Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                          Type Alias MultifactorChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                          MultifactorChallengeResponse:
                                                                                                                                                                                                                                                                                                                                                                                                                              | MultifactorChallengeOTPResponse
                                                                                                                                                                                                                                                                                                                                                                                                                              | MultifactorChallengeOOBResponse
                                                                                                                                                                                                                                                                                                                                                                                                                              | MultifactorChallengeOOBWithBindingResponse

                                                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                                          + + + + + + MultifactorChallengeResponse | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                          + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                                                             + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +

                                                                                                                                                                                                                                                                                                                                                                                                                            Type Alias MultifactorChallengeResponse

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + MultifactorChallengeResponse:
                                                                                                                                                                                                                                                                                                                                                                                                                                | + MultifactorChallengeOTPResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                | + MultifactorChallengeOOBResponse
                                                                                                                                                                                                                                                                                                                                                                                                                                | + MultifactorChallengeOOBWithBindingResponse +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + + +

                                                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                                                            +                                                                                                                                                                                                                                                                                                                                                                                                                             +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                            • + +
                                                                                                                                                                                                                                                                                                                                                                                                                              • +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                                                            + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                                                                                            + + diff --git a/docs/types/Types.Auth0Response.html b/docs/types/Types.Auth0Response.html index 96475825..539f0e6f 100644 --- a/docs/types/Types.Auth0Response.html +++ b/docs/types/Types.Auth0Response.html @@ -1,6 +1,571 @@ -Auth0Response | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                            react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                              Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Auth0Response<TData>

                                                                                                                                                                                                                                                                                                                                                                                                                              type Auth0Response<TData> = {
                                                                                                                                                                                                                                                                                                                                                                                                                                  headers?: Headers;
                                                                                                                                                                                                                                                                                                                                                                                                                                  json?: TData;
                                                                                                                                                                                                                                                                                                                                                                                                                                  ok?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                  status: number;
                                                                                                                                                                                                                                                                                                                                                                                                                                  text?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                              • TData
                                                                                                                                                                                                                                                                                                                                                                                                                              Index

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              headers? -json? -ok? -status -text? -

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties

                                                                                                                                                                                                                                                                                                                                                                                                                              headers?: Headers
                                                                                                                                                                                                                                                                                                                                                                                                                              json?: TData
                                                                                                                                                                                                                                                                                                                                                                                                                              ok?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                              status: number

                                                                                                                                                                                                                                                                                                                                                                                                                              Optionaltext

                                                                                                                                                                                                                                                                                                                                                                                                                              text?: string

                                                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                              Properties
                                                                                                                                                                                                                                                                                                                                                                                                                              + + + + + + Auth0Response | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                                                              + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                                                                 + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Alias Auth0Response<TData>

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + type + Auth0Response<TData> + = + {
                                                                                                                                                                                                                                                                                                                                                                                                                                    headers?: + Headers;
                                                                                                                                                                                                                                                                                                                                                                                                                                    json?: + TData;
                                                                                                                                                                                                                                                                                                                                                                                                                                    ok?: + boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                    status: + number;
                                                                                                                                                                                                                                                                                                                                                                                                                                    text?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                } +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                • + TData +
                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                Index
                                                                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + headers? + + json? + + ok? + + status + + text? +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                + headers?: + Headers +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                + json?: + TData +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                + ok?: + boolean +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                + status: + number +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                + Optionaltext +

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + text?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                • + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  • +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                +                                                                                                                                                                                                                                                                                                                                                                                                                                 +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                                                                                + + diff --git a/docs/types/Types.Telemetry.html b/docs/types/Types.Telemetry.html index 5c64be31..5882cef6 100644 --- a/docs/types/Types.Telemetry.html +++ b/docs/types/Types.Telemetry.html @@ -1,4 +1,453 @@ -Telemetry | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                                react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                                  Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                  Type Alias Telemetry

                                                                                                                                                                                                                                                                                                                                                                                                                                  type Telemetry = {
                                                                                                                                                                                                                                                                                                                                                                                                                                      env?: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                      version?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                  }
                                                                                                                                                                                                                                                                                                                                                                                                                                  Index

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  env? -name? -version? -

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                  env?: any
                                                                                                                                                                                                                                                                                                                                                                                                                                  name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                  version?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                  Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                  + + + + + + Telemetry | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                                                  + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                                                     + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Type Alias Telemetry

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + type + Telemetry + = + {
                                                                                                                                                                                                                                                                                                                                                                                                                                        env?: + any;
                                                                                                                                                                                                                                                                                                                                                                                                                                        name?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                        version?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                    } +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    Index
                                                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + env? + + name? + + version? +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + env?: + any +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + name?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + version?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                    • + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      • +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                                                                                    + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                                                    + + diff --git a/docs/types/User.html b/docs/types/User.html index a12e9254..991fe38c 100644 --- a/docs/types/User.html +++ b/docs/types/User.html @@ -1,21 +1,1346 @@ -User | react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                                    react-native-auth0
                                                                                                                                                                                                                                                                                                                                                                                                                                      Preparing search index...

                                                                                                                                                                                                                                                                                                                                                                                                                                      Type Alias User

                                                                                                                                                                                                                                                                                                                                                                                                                                      type User = {
                                                                                                                                                                                                                                                                                                                                                                                                                                          address?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          birthdate?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          email?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          emailVerified?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                          familyName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          gender?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          givenName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          locale?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          middleName?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          nickname?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          phoneNumber?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          phoneNumberVerified?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                          picture?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          preferredUsername?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          profile?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          sub?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          updatedAt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          website?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          zoneinfo?: string;
                                                                                                                                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                                                                      Indexable

                                                                                                                                                                                                                                                                                                                                                                                                                                      • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                                                                                                      Index

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      address? -birthdate? -email? -emailVerified? -familyName? -gender? -givenName? -locale? -middleName? -name? -nickname? -phoneNumber? -phoneNumberVerified? -picture? -preferredUsername? -profile? -sub? -updatedAt? -website? -zoneinfo? -

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                      address?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      birthdate?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      email?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      emailVerified?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                      familyName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      gender?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      givenName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      locale?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      middleName?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      name?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      nickname?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      phoneNumber?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      phoneNumberVerified?: boolean
                                                                                                                                                                                                                                                                                                                                                                                                                                      picture?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      preferredUsername?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      profile?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      sub?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      updatedAt?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      website?: string
                                                                                                                                                                                                                                                                                                                                                                                                                                      zoneinfo?: string

                                                                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                      Properties
                                                                                                                                                                                                                                                                                                                                                                                                                                      + + + + + + User | react-native-auth0 + + + + + + + + + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                                                                                                      + react-native-auth0 + + + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        Preparing search index...
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                                         + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Type Alias User

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + type + User + = + {
                                                                                                                                                                                                                                                                                                                                                                                                                                            address?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            birthdate?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            email?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            emailVerified?: + boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                            familyName?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            gender?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            givenName?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            locale?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            middleName?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            name?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            nickname?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            phoneNumber?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            phoneNumberVerified?: + boolean;
                                                                                                                                                                                                                                                                                                                                                                                                                                            picture?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            preferredUsername?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            profile?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            sub?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            updatedAt?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            website?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            zoneinfo?: + string;
                                                                                                                                                                                                                                                                                                                                                                                                                                            [key: + string]: + any;
                                                                                                                                                                                                                                                                                                                                                                                                                                        } +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Indexable

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

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + address? + + birthdate? + + email? + + emailVerified? + + familyName? + + gender? + + givenName? + + locale? + + middleName? + + name? + + nickname? + + phoneNumber? + + phoneNumberVerified? + + picture? + + preferredUsername? + + profile? + + sub? + + updatedAt? + + website? + + zoneinfo? +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Properties

                                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + address?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + birthdate?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + email?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + emailVerified?: + boolean +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + familyName?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + gender?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + givenName?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + locale?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + middleName?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + name?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + nickname?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + phoneNumber?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + phoneNumberVerified?: + boolean +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + picture?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + preferredUsername?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + profile?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + sub?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + updatedAt?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + website?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + zoneinfo?: + string +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + Member Visibility +
                                                                                                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                        • + +
                                                                                                                                                                                                                                                                                                                                                                                                                                          • +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + + Properties + + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                                                                        + Generated using + TypeDoc +

                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                                                                                                        + +