@elliemae/pui-app-sdk 5.35.0 → 5.36.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/docs/404.html +2 -2
- package/build/docs/api/@elliemae/ds-form/index.html +2 -2
- package/build/docs/api/classes/Analytics/index.html +2 -2
- package/build/docs/api/classes/CMicroAppGuest/index.html +2 -2
- package/build/docs/api/classes/CMicroAppHost/index.html +2 -2
- package/build/docs/api/classes/ErrorBoundary/index.html +2 -2
- package/build/docs/api/functions/AppRoot/index.html +2 -2
- package/build/docs/api/functions/Autocomplete/index.html +2 -2
- package/build/docs/api/functions/CheckBox/index.html +2 -2
- package/build/docs/api/functions/ComboBox/index.html +2 -2
- package/build/docs/api/functions/ComboBoxV3/index.html +2 -2
- package/build/docs/api/functions/ConnectForm/index.html +2 -2
- package/build/docs/api/functions/DateInput/index.html +2 -2
- package/build/docs/api/functions/DatePicker/index.html +2 -2
- package/build/docs/api/functions/DateRangePicker/index.html +2 -2
- package/build/docs/api/functions/DateTimePicker/index.html +2 -2
- package/build/docs/api/functions/Form/index.html +2 -2
- package/build/docs/api/functions/FormItemLayout/index.html +2 -2
- package/build/docs/api/functions/FormLayoutBlockItem/index.html +2 -2
- package/build/docs/api/functions/FormSubmitButton/index.html +2 -2
- package/build/docs/api/functions/InputMask/index.html +2 -2
- package/build/docs/api/functions/InputText/index.html +2 -2
- package/build/docs/api/functions/LargeTextBox/index.html +2 -2
- package/build/docs/api/functions/MaskedInputText/index.html +2 -2
- package/build/docs/api/functions/Page/index.html +2 -2
- package/build/docs/api/functions/Radio/index.html +2 -2
- package/build/docs/api/functions/RadioGroup/index.html +2 -2
- package/build/docs/api/functions/RegisterService/index.html +2 -2
- package/build/docs/api/functions/RenderWithStateAddOns/index.html +2 -2
- package/build/docs/api/functions/RequireAuth/index.html +12 -6
- package/build/docs/api/functions/SessionTimeout/index.html +2 -2
- package/build/docs/api/functions/TextBox/index.html +2 -2
- package/build/docs/api/functions/Toggle/index.html +2 -2
- package/build/docs/api/functions/authSaga/index.html +2 -2
- package/build/docs/api/functions/authorize/index.html +2 -2
- package/build/docs/api/functions/cleanup/index.html +2 -2
- package/build/docs/api/functions/configureStore/index.html +2 -2
- package/build/docs/api/functions/createManager/index.html +2 -2
- package/build/docs/api/functions/enableReactAppForHostIntegration/index.html +2 -2
- package/build/docs/api/functions/fetchHostAppData/index.html +2 -2
- package/build/docs/api/functions/fetchUserSettings/index.html +2 -2
- package/build/docs/api/functions/getApiActionCreator/index.html +2 -2
- package/build/docs/api/functions/getAppConfigValue/index.html +2 -2
- package/build/docs/api/functions/getAuthHTTPClient/index.html +2 -2
- package/build/docs/api/functions/getAuthorizationHeader/index.html +2 -2
- package/build/docs/api/functions/getHTTPClient/index.html +2 -2
- package/build/docs/api/functions/getHostAppDataByKey/index.html +2 -2
- package/build/docs/api/functions/getLogger/index.html +2 -2
- package/build/docs/api/functions/getMicroFrontEndAppConfig/index.html +2 -2
- package/build/docs/api/functions/getNavigationLinks/index.html +2 -2
- package/build/docs/api/functions/getRedirectUrl/index.html +2 -2
- package/build/docs/api/functions/getSelectField/index.html +2 -2
- package/build/docs/api/functions/getStore/index.html +2 -2
- package/build/docs/api/functions/initServiceWorker/index.html +2 -2
- package/build/docs/api/functions/isCIBuild/index.html +2 -2
- package/build/docs/api/functions/isProd/index.html +2 -2
- package/build/docs/api/functions/isUserAuthorized/index.html +2 -2
- package/build/docs/api/functions/listenStorageEvents/index.html +2 -2
- package/build/docs/api/functions/loadAppConfig/index.html +2 -2
- package/build/docs/api/functions/loadable/index.html +2 -2
- package/build/docs/api/functions/login/index.html +23 -3
- package/build/docs/api/functions/notifyGuestUnloadComplete/index.html +2 -2
- package/build/docs/api/functions/onAuthorizationFailure/index.html +2 -2
- package/build/docs/api/functions/onGuestUnloadStart/index.html +2 -2
- package/build/docs/api/functions/redactPii/index.html +2 -2
- package/build/docs/api/functions/removeDoubleSlash/index.html +2 -2
- package/build/docs/api/functions/removeStorageEvents/index.html +2 -2
- package/build/docs/api/functions/render/index.html +2 -2
- package/build/docs/api/functions/renderHook/index.html +2 -2
- package/build/docs/api/functions/renderWithHostData/index.html +2 -2
- package/build/docs/api/functions/renderWithRedux/index.html +2 -2
- package/build/docs/api/functions/renderWithRouter/index.html +2 -2
- package/build/docs/api/functions/renderWithRouterRedux/index.html +2 -2
- package/build/docs/api/functions/sdkBaseQuery/index.html +2 -2
- package/build/docs/api/functions/sendBAEvent/index.html +2 -2
- package/build/docs/api/functions/sendMessageToHost/index.html +2 -2
- package/build/docs/api/functions/setAppConfig/index.html +2 -2
- package/build/docs/api/functions/setAppConfigValue/index.html +2 -2
- package/build/docs/api/functions/setHostAppData/index.html +2 -2
- package/build/docs/api/functions/setLoginParams/index.html +2 -2
- package/build/docs/api/functions/subscribeToResetSession/index.html +2 -2
- package/build/docs/api/functions/subscribeToSessionExpiry/index.html +2 -2
- package/build/docs/api/functions/subscribeToSessionExpiryWarning/index.html +2 -2
- package/build/docs/api/functions/trackActivity/index.html +2 -2
- package/build/docs/api/functions/useAppDispatch/index.html +2 -2
- package/build/docs/api/functions/useAppMiddleware/index.html +2 -2
- package/build/docs/api/functions/useInjectQuery/index.html +2 -2
- package/build/docs/api/functions/useInjectReducer/index.html +2 -2
- package/build/docs/api/functions/useInjectSaga/index.html +2 -2
- package/build/docs/api/functions/useInjectSideEffect/index.html +2 -2
- package/build/docs/api/functions/useMediaQueryList/index.html +2 -2
- package/build/docs/api/functions/useStateSelector/index.html +2 -2
- package/build/docs/api/functions/useStateSelectorShallow/index.html +2 -2
- package/build/docs/api/functions/waitFor/index.html +2 -2
- package/build/docs/api/functions/waitForElementToBeRemoved/index.html +2 -2
- package/build/docs/api/functions/withAppDecorator/index.html +2 -2
- package/build/docs/api/index.html +3 -3
- package/build/docs/api/interfaces/AppConfig/index.html +2 -2
- package/build/docs/api/interfaces/UseStateSelectorOptions/index.html +2 -2
- package/build/docs/api/type-aliases/AppDispatch/index.html +2 -2
- package/build/docs/api/type-aliases/AppStore/index.html +2 -2
- package/build/docs/api/type-aliases/Await/index.html +2 -2
- package/build/docs/api/type-aliases/EMUI/index.html +2 -2
- package/build/docs/api/type-aliases/OnHostInitCallback/index.html +2 -2
- package/build/docs/api/type-aliases/OnInitCallback/index.html +2 -2
- package/build/docs/api/type-aliases/OnMountCallback/index.html +2 -2
- package/build/docs/api/type-aliases/OnUnMountCallback/index.html +2 -2
- package/build/docs/api/type-aliases/RootState/index.html +2 -2
- package/build/docs/api/type-aliases/SelectStateFieldFunction/index.html +2 -2
- package/build/docs/api/variables/ErrorToast/index.html +2 -2
- package/build/docs/api/variables/GuestMicroApp/index.html +2 -2
- package/build/docs/api/variables/MicroApp/index.html +2 -2
- package/build/docs/api/variables/MicroIFrameApp/index.html +2 -2
- package/build/docs/api/variables/NavigationPrompt/index.html +2 -2
- package/build/docs/api/variables/NavigationPromptActions/index.html +2 -2
- package/build/docs/api/variables/Themes/index.html +2 -2
- package/build/docs/api/variables/VisuallyHidden/index.html +2 -2
- package/build/docs/api/variables/WaitMessage/index.html +2 -2
- package/build/docs/api/variables/act/index.html +2 -2
- package/build/docs/api/variables/ariaLive/index.html +2 -2
- package/build/docs/api/variables/auth/index.html +2 -2
- package/build/docs/api/variables/authReducer/index.html +2 -2
- package/build/docs/api/variables/clearSideEffects/index.html +2 -2
- package/build/docs/api/variables/createSideEffect/index.html +2 -2
- package/build/docs/api/variables/decorators/index.html +2 -2
- package/build/docs/api/variables/endSession/index.html +5 -3
- package/build/docs/api/variables/error/index.html +2 -2
- package/build/docs/api/variables/errorMiddleware/index.html +2 -2
- package/build/docs/api/variables/fireEvent/index.html +2 -2
- package/build/docs/api/variables/globalConstants/index.html +2 -2
- package/build/docs/api/variables/history/index.html +2 -2
- package/build/docs/api/variables/httpClientProps/index.html +2 -2
- package/build/docs/api/variables/logout/index.html +2 -2
- package/build/docs/api/variables/memoryHistory/index.html +2 -2
- package/build/docs/api/variables/removeSideEffect/index.html +2 -2
- package/build/docs/api/variables/resetUserIdleTime/index.html +2 -2
- package/build/docs/api/variables/screen/index.html +2 -2
- package/build/docs/api/variables/startSideEffect/index.html +2 -2
- package/build/docs/api/variables/updateBAEventParameters/index.html +2 -2
- package/build/docs/api/variables/useAppSelector/index.html +2 -2
- package/build/docs/api/variables/waitMessageAction/index.html +2 -2
- package/build/docs/api/variables/within/index.html +2 -2
- package/build/docs/assets/js/{5e8c322a.97dedf84.js → 5e8c322a.aa5dce33.js} +1 -1
- package/build/docs/assets/js/{822e0178.9d4d52c2.js → 822e0178.c247e771.js} +1 -1
- package/build/docs/assets/js/a6c41565.fa578abf.js +1 -0
- package/build/docs/assets/js/a6c5c03c.f2cbe66f.js +1 -0
- package/build/docs/assets/js/d071c513.26ec37a4.js +1 -0
- package/build/docs/assets/js/{main.14be0487.js → main.50d99a6d.js} +2 -2
- package/build/docs/assets/js/{runtime~main.b5410b34.js → runtime~main.e3dd1cce.js} +1 -1
- package/build/docs/index.html +2 -2
- package/build/docs/usage-guide/index.html +2 -2
- package/demo/{177.3c5bbe97.iframe.bundle.js → 177.a6f93dd4.iframe.bundle.js} +1 -1
- package/demo/177.a6f93dd4.iframe.bundle.js.br +0 -0
- package/demo/177.a6f93dd4.iframe.bundle.js.gz +0 -0
- package/demo/docs/{177.3c5bbe97.iframe.bundle.js → 177.a6f93dd4.iframe.bundle.js} +1 -1
- package/demo/docs/177.a6f93dd4.iframe.bundle.js.br +0 -0
- package/demo/docs/177.a6f93dd4.iframe.bundle.js.gz +0 -0
- package/demo/docs/iframe.html +1 -1
- package/demo/docs/index.html +1 -1
- package/demo/docs/{main.6b7b215d1117159d9e43.manager.bundle.js → main.994f586d2ea55c7b3611.manager.bundle.js} +1 -1
- package/demo/docs/{main.6b7b215d1117159d9e43.manager.bundle.js.br → main.994f586d2ea55c7b3611.manager.bundle.js.br} +0 -0
- package/demo/docs/{main.6b7b215d1117159d9e43.manager.bundle.js.gz → main.994f586d2ea55c7b3611.manager.bundle.js.gz} +0 -0
- package/demo/docs/main.b591c5b8.iframe.bundle.js +5 -0
- package/demo/docs/main.b591c5b8.iframe.bundle.js.br +0 -0
- package/demo/docs/main.b591c5b8.iframe.bundle.js.gz +0 -0
- package/demo/docs/project.json +1 -1
- package/demo/iframe.html +1 -1
- package/demo/index.html +1 -1
- package/demo/{main.6b7b215d1117159d9e43.manager.bundle.js → main.994f586d2ea55c7b3611.manager.bundle.js} +1 -1
- package/demo/{main.6b7b215d1117159d9e43.manager.bundle.js.br → main.994f586d2ea55c7b3611.manager.bundle.js.br} +0 -0
- package/demo/{main.6b7b215d1117159d9e43.manager.bundle.js.gz → main.994f586d2ea55c7b3611.manager.bundle.js.gz} +0 -0
- package/demo/main.b591c5b8.iframe.bundle.js +5 -0
- package/demo/main.b591c5b8.iframe.bundle.js.br +0 -0
- package/demo/main.b591c5b8.iframe.bundle.js.gz +0 -0
- package/demo/project.json +1 -1
- package/dist/cjs/data/auth/actions.js +10 -2
- package/dist/cjs/utils/auth/index.js +59 -18
- package/dist/cjs/view/error-toast/index.js +15 -3
- package/dist/cjs/view/login/index.js +31 -2
- package/dist/cjs/view/require-auth.js +12 -0
- package/dist/esm/data/auth/actions.js +10 -2
- package/dist/esm/utils/auth/index.js +59 -18
- package/dist/esm/view/error-toast/index.js +21 -4
- package/dist/esm/view/login/index.js +31 -2
- package/dist/esm/view/require-auth.js +12 -0
- package/dist/types/lib/data/auth/actions.d.ts +2 -1
- package/dist/types/lib/utils/auth/index.d.ts +47 -3
- package/dist/types/lib/utils/auth/types.d.ts +1 -0
- package/dist/types/lib/view/login/index.d.ts +29 -1
- package/dist/types/lib/view/login/tests/index.test.d.ts +1 -0
- package/dist/types/lib/view/require-auth.d.ts +30 -1
- package/dist/types/lib/view/tests/require-auth.test.d.ts +1 -0
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +1 -1
- package/build/docs/assets/js/a6c41565.8fb7e683.js +0 -1
- package/build/docs/assets/js/a6c5c03c.50c09428.js +0 -1
- package/build/docs/assets/js/d071c513.23b54fe3.js +0 -1
- package/demo/177.3c5bbe97.iframe.bundle.js.br +0 -0
- package/demo/177.3c5bbe97.iframe.bundle.js.gz +0 -0
- package/demo/docs/177.3c5bbe97.iframe.bundle.js.br +0 -0
- package/demo/docs/177.3c5bbe97.iframe.bundle.js.gz +0 -0
- package/demo/docs/main.6037fcf6.iframe.bundle.js +0 -5
- package/demo/docs/main.6037fcf6.iframe.bundle.js.br +0 -0
- package/demo/docs/main.6037fcf6.iframe.bundle.js.gz +0 -0
- package/demo/main.6037fcf6.iframe.bundle.js +0 -5
- package/demo/main.6037fcf6.iframe.bundle.js.br +0 -0
- package/demo/main.6037fcf6.iframe.bundle.js.gz +0 -0
- /package/build/docs/assets/js/{main.14be0487.js.LICENSE.txt → main.50d99a6d.js.LICENSE.txt} +0 -0
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">getSelectField() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/getSelectField"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="getSelectField() | App SDK"><meta data-rh="true" name="description" content="Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store"><meta data-rh="true" property="og:description" content="Why use this? It will prevent unnecessary rerenders hence improving performance, it also reduces the amount of code needed to select data from the store"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/getSelectField"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/getSelectField" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/getSelectField" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"getSelectField()","item":"https://pui.ice.com/app-sdk/api/functions/getSelectField"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">getStore() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/getStore"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="getStore() | App SDK"><meta data-rh="true" name="description" content="Gets the global Redux store instance."><meta data-rh="true" property="og:description" content="Gets the global Redux store instance."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/getStore"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/getStore" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/getStore" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"getStore()","item":"https://pui.ice.com/app-sdk/api/functions/getStore"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">initServiceWorker() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/initServiceWorker"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="initServiceWorker() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/initServiceWorker"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/initServiceWorker" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/initServiceWorker" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"initServiceWorker()","item":"https://pui.ice.com/app-sdk/api/functions/initServiceWorker"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">isCIBuild() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/isCIBuild"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="isCIBuild() | App SDK"><meta data-rh="true" name="description" content="Returns"><meta data-rh="true" property="og:description" content="Returns"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/isCIBuild"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/isCIBuild" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/isCIBuild" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"isCIBuild()","item":"https://pui.ice.com/app-sdk/api/functions/isCIBuild"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">isProd() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/isProd"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="isProd() | App SDK"><meta data-rh="true" name="description" content="Returns"><meta data-rh="true" property="og:description" content="Returns"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/isProd"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/isProd" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/isProd" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"isProd()","item":"https://pui.ice.com/app-sdk/api/functions/isProd"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">isUserAuthorized() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/isUserAuthorized"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="isUserAuthorized() | App SDK"><meta data-rh="true" name="description" content="Checks if the user is currently authorized/authenticated."><meta data-rh="true" property="og:description" content="Checks if the user is currently authorized/authenticated."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/isUserAuthorized"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/isUserAuthorized" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/isUserAuthorized" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"isUserAuthorized()","item":"https://pui.ice.com/app-sdk/api/functions/isUserAuthorized"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">listenStorageEvents() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/listenStorageEvents"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="listenStorageEvents() | App SDK"><meta data-rh="true" name="description" content="Returns"><meta data-rh="true" property="og:description" content="Returns"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/listenStorageEvents"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/listenStorageEvents" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/listenStorageEvents" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"listenStorageEvents()","item":"https://pui.ice.com/app-sdk/api/functions/listenStorageEvents"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">loadAppConfig() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/loadAppConfig"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="loadAppConfig() | App SDK"><meta data-rh="true" name="description" content="Loads the application configuration from a JSON file."><meta data-rh="true" property="og:description" content="Loads the application configuration from a JSON file."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/loadAppConfig"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/loadAppConfig" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/loadAppConfig" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"loadAppConfig()","item":"https://pui.ice.com/app-sdk/api/functions/loadAppConfig"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">loadable() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/loadable"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="loadable() | App SDK"><meta data-rh="true" name="description" content="Creates a lazily-loaded React component for code splitting."><meta data-rh="true" property="og:description" content="Creates a lazily-loaded React component for code splitting."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/loadable"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/loadable" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/loadable" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"loadable()","item":"https://pui.ice.com/app-sdk/api/functions/loadable"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,15 +4,15 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">login() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/login"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="login() | App SDK"><meta data-rh="true" name="description" content="Initiates the login flow using OAuth/OIDC authorization code flow."><meta data-rh="true" property="og:description" content="Initiates the login flow using OAuth/OIDC authorization code flow."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/login"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/login" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/login" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"login()","item":"https://pui.ice.com/app-sdk/api/functions/login"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
12
12
|
<symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol>
|
|
13
13
|
</defs></svg>
|
|
14
14
|
<script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_eGlE" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/app-sdk/"><div class="navbar__logo"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_Q3jx themedComponent--light_BjHx"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_Q3jx themedComponent--dark_mxj9"></div><b class="navbar__title text--truncate">App SDK</b></a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/">Getting Started</a><a aria-current="page" class="navbar__item navbar__link navbar__link--active" href="/app-sdk/api">API</a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_kEbG"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_S6Pl colorModeToggle_L96j"><button class="clean-btn toggleButton_Wf77 toggleButtonDisabled_JaY9" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk lightToggleIcon_X2ll"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk darkToggleIcon_kYIm"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_tqpk systemToggleIcon_mG1q"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_dSE1"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_vmWZ"><div class="docsWrapper_es0q"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_cO8Y" type="button"></button><div class="docRoot_cyW0"><aside class="theme-doc-sidebar-container docSidebarContainer_yHv_"><div class="sidebarViewport_iaL1"><div class="sidebar_Xoux"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_Qdup"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--active" href="/app-sdk/api/"><span title="App SDK API" class="categoryLinkLabel_I_MP">App SDK API</span></a><button aria-label="Collapse sidebar category 'App SDK API'" aria-expanded="true" type="button" class="clean-btn menu__caret"></button></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/@elliemae/ds-form/"><span title="@elliemae" class="categoryLinkLabel_I_MP">@elliemae</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/classes/Analytics"><span title="classes" class="categoryLinkLabel_I_MP">classes</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/app-sdk/api/functions/AppRoot"><span title="functions" class="categoryLinkLabel_I_MP">functions</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/AppRoot"><span title="AppRoot()" class="linkLabel_Knm1">AppRoot()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/Autocomplete"><span title="Autocomplete()" class="linkLabel_Knm1">Autocomplete()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/CheckBox"><span title="CheckBox()" class="linkLabel_Knm1">CheckBox()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/ComboBox"><span title="ComboBox()" class="linkLabel_Knm1">ComboBox()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/ComboBoxV3"><span title="ComboBoxV3()" class="linkLabel_Knm1">ComboBoxV3()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/ConnectForm"><span title="ConnectForm()" class="linkLabel_Knm1">ConnectForm()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/DateInput"><span title="DateInput()" class="linkLabel_Knm1">DateInput()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/DatePicker"><span title="DatePicker()" class="linkLabel_Knm1">DatePicker()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/DateRangePicker"><span title="DateRangePicker()" class="linkLabel_Knm1">DateRangePicker()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/DateTimePicker"><span title="DateTimePicker()" class="linkLabel_Knm1">DateTimePicker()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/Form"><span title="Form()" class="linkLabel_Knm1">Form()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/FormItemLayout"><span title="FormItemLayout()" class="linkLabel_Knm1">FormItemLayout()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/FormLayoutBlockItem"><span title="FormLayoutBlockItem()" class="linkLabel_Knm1">FormLayoutBlockItem()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/FormSubmitButton"><span title="FormSubmitButton()" class="linkLabel_Knm1">FormSubmitButton()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/InputMask"><span title="InputMask()" class="linkLabel_Knm1">InputMask()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/InputText"><span title="InputText()" class="linkLabel_Knm1">InputText()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/LargeTextBox"><span title="LargeTextBox()" class="linkLabel_Knm1">LargeTextBox()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/MaskedInputText"><span title="MaskedInputText()" class="linkLabel_Knm1">MaskedInputText()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/Page"><span title="Page()" class="linkLabel_Knm1">Page()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/Radio"><span title="Radio()" class="linkLabel_Knm1">Radio()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/RadioGroup"><span title="RadioGroup()" class="linkLabel_Knm1">RadioGroup()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/RegisterService"><span title="RegisterService()" class="linkLabel_Knm1">RegisterService()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/RenderWithStateAddOns"><span title="RenderWithStateAddOns()" class="linkLabel_Knm1">RenderWithStateAddOns()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/RequireAuth"><span title="RequireAuth()" class="linkLabel_Knm1">RequireAuth()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/SessionTimeout"><span title="SessionTimeout()" class="linkLabel_Knm1">SessionTimeout()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/TextBox"><span title="TextBox()" class="linkLabel_Knm1">TextBox()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/Toggle"><span title="Toggle()" class="linkLabel_Knm1">Toggle()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/authSaga"><span title="authSaga()" class="linkLabel_Knm1">authSaga()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/authorize"><span title="authorize()" class="linkLabel_Knm1">authorize()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/cleanup"><span title="cleanup()" class="linkLabel_Knm1">cleanup()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/configureStore"><span title="configureStore()" class="linkLabel_Knm1">configureStore()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/createManager"><span title="createManager()" class="linkLabel_Knm1">createManager()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/enableReactAppForHostIntegration"><span title="enableReactAppForHostIntegration()" class="linkLabel_Knm1">enableReactAppForHostIntegration()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/fetchHostAppData"><span title="fetchHostAppData()" class="linkLabel_Knm1">fetchHostAppData()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/fetchUserSettings"><span title="fetchUserSettings()" class="linkLabel_Knm1">fetchUserSettings()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getApiActionCreator"><span title="getApiActionCreator()" class="linkLabel_Knm1">getApiActionCreator()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getAppConfigValue"><span title="getAppConfigValue()" class="linkLabel_Knm1">getAppConfigValue()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getAuthHTTPClient"><span title="getAuthHTTPClient()" class="linkLabel_Knm1">getAuthHTTPClient()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getAuthorizationHeader"><span title="getAuthorizationHeader()" class="linkLabel_Knm1">getAuthorizationHeader()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getHTTPClient"><span title="getHTTPClient()" class="linkLabel_Knm1">getHTTPClient()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getHostAppDataByKey"><span title="getHostAppDataByKey()" class="linkLabel_Knm1">getHostAppDataByKey()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getLogger"><span title="getLogger()" class="linkLabel_Knm1">getLogger()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getMicroFrontEndAppConfig"><span title="getMicroFrontEndAppConfig()" class="linkLabel_Knm1">getMicroFrontEndAppConfig()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getNavigationLinks"><span title="getNavigationLinks()" class="linkLabel_Knm1">getNavigationLinks()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getRedirectUrl"><span title="getRedirectUrl()" class="linkLabel_Knm1">getRedirectUrl()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getSelectField"><span title="getSelectField()" class="linkLabel_Knm1">getSelectField()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/getStore"><span title="getStore()" class="linkLabel_Knm1">getStore()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/initServiceWorker"><span title="initServiceWorker()" class="linkLabel_Knm1">initServiceWorker()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/isCIBuild"><span title="isCIBuild()" class="linkLabel_Knm1">isCIBuild()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/isProd"><span title="isProd()" class="linkLabel_Knm1">isProd()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/isUserAuthorized"><span title="isUserAuthorized()" class="linkLabel_Knm1">isUserAuthorized()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/listenStorageEvents"><span title="listenStorageEvents()" class="linkLabel_Knm1">listenStorageEvents()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/loadAppConfig"><span title="loadAppConfig()" class="linkLabel_Knm1">loadAppConfig()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/loadable"><span title="loadable()" class="linkLabel_Knm1">loadable()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/app-sdk/api/functions/login"><span title="login()" class="linkLabel_Knm1">login()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/notifyGuestUnloadComplete"><span title="notifyGuestUnloadComplete()" class="linkLabel_Knm1">notifyGuestUnloadComplete()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/onAuthorizationFailure"><span title="onAuthorizationFailure()" class="linkLabel_Knm1">onAuthorizationFailure()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/onGuestUnloadStart"><span title="onGuestUnloadStart()" class="linkLabel_Knm1">onGuestUnloadStart()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/redactPii"><span title="redactPii()" class="linkLabel_Knm1">redactPii()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/removeDoubleSlash"><span title="removeDoubleSlash()" class="linkLabel_Knm1">removeDoubleSlash()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/removeStorageEvents"><span title="removeStorageEvents()" class="linkLabel_Knm1">removeStorageEvents()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/render"><span title="render()" class="linkLabel_Knm1">render()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/renderHook"><span title="renderHook()" class="linkLabel_Knm1">renderHook()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/renderWithHostData"><span title="renderWithHostData()" class="linkLabel_Knm1">renderWithHostData()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/renderWithRedux"><span title="renderWithRedux()" class="linkLabel_Knm1">renderWithRedux()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/renderWithRouter"><span title="renderWithRouter()" class="linkLabel_Knm1">renderWithRouter()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/renderWithRouterRedux"><span title="renderWithRouterRedux()" class="linkLabel_Knm1">renderWithRouterRedux()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/sdkBaseQuery"><span title="sdkBaseQuery()" class="linkLabel_Knm1">sdkBaseQuery()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/sendBAEvent"><span title="~~sendBAEvent()~~" class="linkLabel_Knm1">~~sendBAEvent()~~</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/sendMessageToHost"><span title="sendMessageToHost()" class="linkLabel_Knm1">sendMessageToHost()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/setAppConfig"><span title="setAppConfig()" class="linkLabel_Knm1">setAppConfig()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/setAppConfigValue"><span title="setAppConfigValue()" class="linkLabel_Knm1">setAppConfigValue()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/setHostAppData"><span title="setHostAppData()" class="linkLabel_Knm1">setHostAppData()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/setLoginParams"><span title="setLoginParams()" class="linkLabel_Knm1">setLoginParams()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/subscribeToResetSession"><span title="subscribeToResetSession()" class="linkLabel_Knm1">subscribeToResetSession()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/subscribeToSessionExpiry"><span title="subscribeToSessionExpiry()" class="linkLabel_Knm1">subscribeToSessionExpiry()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/subscribeToSessionExpiryWarning"><span title="subscribeToSessionExpiryWarning()" class="linkLabel_Knm1">subscribeToSessionExpiryWarning()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/trackActivity"><span title="trackActivity()" class="linkLabel_Knm1">trackActivity()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useAppDispatch"><span title="useAppDispatch()" class="linkLabel_Knm1">useAppDispatch()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useAppMiddleware"><span title="useAppMiddleware()" class="linkLabel_Knm1">useAppMiddleware()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useInjectQuery"><span title="useInjectQuery()" class="linkLabel_Knm1">useInjectQuery()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useInjectReducer"><span title="useInjectReducer()" class="linkLabel_Knm1">useInjectReducer()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useInjectSaga"><span title="useInjectSaga()" class="linkLabel_Knm1">useInjectSaga()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useInjectSideEffect"><span title="useInjectSideEffect()" class="linkLabel_Knm1">useInjectSideEffect()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useMediaQueryList"><span title="useMediaQueryList()" class="linkLabel_Knm1">useMediaQueryList()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useStateSelector"><span title="useStateSelector()" class="linkLabel_Knm1">useStateSelector()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/useStateSelectorShallow"><span title="useStateSelectorShallow()" class="linkLabel_Knm1">useStateSelectorShallow()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/waitFor"><span title="waitFor()" class="linkLabel_Knm1">waitFor()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/waitForElementToBeRemoved"><span title="waitForElementToBeRemoved()" class="linkLabel_Knm1">waitForElementToBeRemoved()</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/app-sdk/api/functions/withAppDecorator"><span title="withAppDecorator()" class="linkLabel_Knm1">withAppDecorator()</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/interfaces/AppConfig"><span title="interfaces" class="categoryLinkLabel_I_MP">interfaces</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/type-aliases/AppDispatch"><span title="type-aliases" class="categoryLinkLabel_I_MP">type-aliases</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_BCi1 menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/variables/ErrorToast"><span title="variables" class="categoryLinkLabel_I_MP">variables</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/"><span title="Getting Started" class="linkLabel_Knm1">Getting Started</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/app-sdk/usage-guide"><span title="Usage Guide" class="linkLabel_Knm1">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_qgvB"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_Rp9M"><div class="docItemContainer_reKL"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_L00V" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/app-sdk/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_BtgF"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><a class="breadcrumbs__link" href="/app-sdk/api/"><span>App SDK API</span></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">functions</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">login()</span></li></ul></nav><div class="tocCollapsible_tUTH theme-doc-toc-mobile tocMobile_Bfsw"><button type="button" class="clean-btn tocCollapsibleButton_YuJU">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>login()</h1></header>
|
|
15
|
-
<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">function</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">login</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">params</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> clientId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> isConsumerUser</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> responseType</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> scope</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Promise</span><span class="token operator" style="color:#393A34"><</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> authorized</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
15
|
+
<div class="language-ts codeBlockContainer_hfT5 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_7tLg"><pre tabindex="0" class="prism-code language-ts codeBlock_jGqy thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_reRH"><span class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">function</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">login</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">params</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> clientId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> disableRememberMe</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> instanceId</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> isConsumerUser</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> isSSO</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> responseType</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> scope</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> siteId</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> useCompactIdpPage</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> userId</span><span class="token operator" style="color:#393A34">?</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">Promise</span><span class="token operator" style="color:#393A34"><</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> authorized</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">boolean</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token punctuation" style="color:#393A34">}</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">;</span><br></span></code></pre></div></div>
|
|
16
16
|
<p>Initiates the login flow using OAuth/OIDC authorization code flow.
|
|
17
17
|
If authorization code is present in URL, completes the authorization.
|
|
18
18
|
Otherwise, redirects to the identity provider's login page.</p>
|
|
@@ -22,15 +22,35 @@ Otherwise, redirects to the identity provider's login page.</p>
|
|
|
22
22
|
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="clientid">clientId<a href="#clientid" class="hash-link" aria-label="Direct link to clientId" title="Direct link to clientId" translate="no"></a></h4>
|
|
23
23
|
<p><code>string</code></p>
|
|
24
24
|
<p>OAuth client ID</p>
|
|
25
|
+
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="disablerememberme">disableRememberMe?<a href="#disablerememberme" class="hash-link" aria-label="Direct link to disableRememberMe?" title="Direct link to disableRememberMe?" translate="no"></a></h4>
|
|
26
|
+
<p><code>boolean</code></p>
|
|
27
|
+
<p>(Optional) Whether to disable the
|
|
28
|
+
"Remember Me" option.</p>
|
|
29
|
+
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="instanceid">instanceId?<a href="#instanceid" class="hash-link" aria-label="Direct link to instanceId?" title="Direct link to instanceId?" translate="no"></a></h4>
|
|
30
|
+
<p><code>number</code></p>
|
|
31
|
+
<p>(Optional) The instance identifier.</p>
|
|
25
32
|
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="isconsumeruser">isConsumerUser<a href="#isconsumeruser" class="hash-link" aria-label="Direct link to isConsumerUser" title="Direct link to isConsumerUser" translate="no"></a></h4>
|
|
26
33
|
<p><code>boolean</code></p>
|
|
27
34
|
<p>Whether user is a consumer user</p>
|
|
35
|
+
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="issso">isSSO?<a href="#issso" class="hash-link" aria-label="Direct link to isSSO?" title="Direct link to isSSO?" translate="no"></a></h4>
|
|
36
|
+
<p><code>boolean</code></p>
|
|
37
|
+
<p>(Optional). Determines whether to use SSO or not.</p>
|
|
28
38
|
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="responsetype">responseType<a href="#responsetype" class="hash-link" aria-label="Direct link to responseType" title="Direct link to responseType" translate="no"></a></h4>
|
|
29
39
|
<p><code>string</code></p>
|
|
30
40
|
<p>OAuth response type (typically 'code')</p>
|
|
31
41
|
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="scope">scope<a href="#scope" class="hash-link" aria-label="Direct link to scope" title="Direct link to scope" translate="no"></a></h4>
|
|
32
42
|
<p><code>string</code></p>
|
|
33
43
|
<p>OAuth scopes (e.g., 'openid profile email')</p>
|
|
44
|
+
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="siteid">siteId?<a href="#siteid" class="hash-link" aria-label="Direct link to siteId?" title="Direct link to siteId?" translate="no"></a></h4>
|
|
45
|
+
<p><code>number</code></p>
|
|
46
|
+
<p>(Optional) The site identifier.</p>
|
|
47
|
+
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="usecompactidppage">useCompactIdpPage?<a href="#usecompactidppage" class="hash-link" aria-label="Direct link to useCompactIdpPage?" title="Direct link to useCompactIdpPage?" translate="no"></a></h4>
|
|
48
|
+
<p><code>boolean</code></p>
|
|
49
|
+
<p>(Optional). Determines whether to use a compact or
|
|
50
|
+
full IDP page.</p>
|
|
51
|
+
<h4 class="anchor anchorTargetStickyNavbar_UXZL" id="userid">userId?<a href="#userid" class="hash-link" aria-label="Direct link to userId?" title="Direct link to userId?" translate="no"></a></h4>
|
|
52
|
+
<p><code>string</code></p>
|
|
53
|
+
<p>(Optional) The user identifier.</p>
|
|
34
54
|
<h2 class="anchor anchorTargetStickyNavbar_UXZL" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h2>
|
|
35
55
|
<p><code>Promise</code><{
|
|
36
56
|
<code>authorized</code>: <code>boolean</code>;
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">notifyGuestUnloadComplete() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/notifyGuestUnloadComplete"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="notifyGuestUnloadComplete() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/notifyGuestUnloadComplete"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/notifyGuestUnloadComplete" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/notifyGuestUnloadComplete" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"notifyGuestUnloadComplete()","item":"https://pui.ice.com/app-sdk/api/functions/notifyGuestUnloadComplete"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">onAuthorizationFailure() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/onAuthorizationFailure"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="onAuthorizationFailure() | App SDK"><meta data-rh="true" name="description" content="Registers a callback to handle authorization failures (401 errors)."><meta data-rh="true" property="og:description" content="Registers a callback to handle authorization failures (401 errors)."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/onAuthorizationFailure"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/onAuthorizationFailure" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/onAuthorizationFailure" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"onAuthorizationFailure()","item":"https://pui.ice.com/app-sdk/api/functions/onAuthorizationFailure"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">onGuestUnloadStart() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/onGuestUnloadStart"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="onGuestUnloadStart() | App SDK"><meta data-rh="true" name="description" content="Returns"><meta data-rh="true" property="og:description" content="Returns"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/onGuestUnloadStart"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/onGuestUnloadStart" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/onGuestUnloadStart" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"onGuestUnloadStart()","item":"https://pui.ice.com/app-sdk/api/functions/onGuestUnloadStart"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">redactPii() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/redactPii"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="redactPii() | App SDK"><meta data-rh="true" name="description" content="Redacts personally identifiable information (PII) from data objects."><meta data-rh="true" property="og:description" content="Redacts personally identifiable information (PII) from data objects."><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/redactPii"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/redactPii" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/redactPii" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"redactPii()","item":"https://pui.ice.com/app-sdk/api/functions/redactPii"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">removeDoubleSlash() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/removeDoubleSlash"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="removeDoubleSlash() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/removeDoubleSlash"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/removeDoubleSlash" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/removeDoubleSlash" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"removeDoubleSlash()","item":"https://pui.ice.com/app-sdk/api/functions/removeDoubleSlash"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">removeStorageEvents() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/removeStorageEvents"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="removeStorageEvents() | App SDK"><meta data-rh="true" name="description" content="Returns"><meta data-rh="true" property="og:description" content="Returns"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/removeStorageEvents"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/removeStorageEvents" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/removeStorageEvents" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"removeStorageEvents()","item":"https://pui.ice.com/app-sdk/api/functions/removeStorageEvents"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">render() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/render"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="render() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/render"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/render" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/render" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"render()","item":"https://pui.ice.com/app-sdk/api/functions/render"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">renderHook() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/renderHook"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="renderHook() | App SDK"><meta data-rh="true" name="description" content="Allows you to render a hook within a test React component without having to"><meta data-rh="true" property="og:description" content="Allows you to render a hook within a test React component without having to"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/renderHook"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderHook" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderHook" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"renderHook()","item":"https://pui.ice.com/app-sdk/api/functions/renderHook"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">renderWithHostData() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/renderWithHostData"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="renderWithHostData() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/renderWithHostData"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderWithHostData" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderWithHostData" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"renderWithHostData()","item":"https://pui.ice.com/app-sdk/api/functions/renderWithHostData"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">renderWithRedux() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/renderWithRedux"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="renderWithRedux() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/renderWithRedux"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderWithRedux" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderWithRedux" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"renderWithRedux()","item":"https://pui.ice.com/app-sdk/api/functions/renderWithRedux"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
<meta charset="UTF-8">
|
|
5
5
|
<meta name="generator" content="Docusaurus v3.9.2">
|
|
6
6
|
<title data-rh="true">renderWithRouter() | App SDK</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://pui.ice.com/app-sdk/api/functions/renderWithRouter"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="renderWithRouter() | App SDK"><meta data-rh="true" name="description" content="Parameters"><meta data-rh="true" property="og:description" content="Parameters"><link data-rh="true" rel="icon" href="/app-sdk/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://pui.ice.com/app-sdk/api/functions/renderWithRouter"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderWithRouter" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/functions/renderWithRouter" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"App SDK API","item":"https://pui.ice.com/app-sdk/api/"},{"@type":"ListItem","position":2,"name":"renderWithRouter()","item":"https://pui.ice.com/app-sdk/api/functions/renderWithRouter"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.48d5ef50.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.
|
|
8
|
-
<script src="/app-sdk/assets/js/main.
|
|
7
|
+
<script src="/app-sdk/assets/js/runtime~main.e3dd1cce.js" defer="defer"></script>
|
|
8
|
+
<script src="/app-sdk/assets/js/main.50d99a6d.js" defer="defer"></script>
|
|
9
9
|
</head>
|
|
10
10
|
<body class="navigation-with-keyboard">
|
|
11
11
|
<svg style="display: none;"><defs>
|