@elliemae/pui-app-sdk 5.40.3 → 5.40.4
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/demo/{6879.3434f1e9.iframe.bundle.js → 8201.6a8c0542.iframe.bundle.js} +449 -449
- package/demo/8201.6a8c0542.iframe.bundle.js.br +0 -0
- package/demo/8201.6a8c0542.iframe.bundle.js.gz +0 -0
- package/demo/docs/{6879.3434f1e9.iframe.bundle.js → 8201.6a8c0542.iframe.bundle.js} +449 -449
- package/demo/docs/8201.6a8c0542.iframe.bundle.js.br +0 -0
- package/demo/docs/8201.6a8c0542.iframe.bundle.js.gz +0 -0
- package/demo/docs/iframe.html +1 -1
- package/demo/docs/index.html +1 -1
- package/demo/docs/main.15fc50b1.iframe.bundle.js +5 -0
- package/demo/docs/main.15fc50b1.iframe.bundle.js.br +0 -0
- package/demo/docs/main.15fc50b1.iframe.bundle.js.gz +0 -0
- package/demo/docs/{main.f4b9fb997236ae69d894.manager.bundle.js → main.4b26e7c4efd9fa564d80.manager.bundle.js} +1 -1
- package/demo/docs/main.4b26e7c4efd9fa564d80.manager.bundle.js.br +0 -0
- package/demo/docs/{main.f4b9fb997236ae69d894.manager.bundle.js.gz → main.4b26e7c4efd9fa564d80.manager.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.15fc50b1.iframe.bundle.js +5 -0
- package/demo/main.15fc50b1.iframe.bundle.js.br +0 -0
- package/demo/main.15fc50b1.iframe.bundle.js.gz +0 -0
- package/demo/{main.f4b9fb997236ae69d894.manager.bundle.js → main.4b26e7c4efd9fa564d80.manager.bundle.js} +1 -1
- package/demo/main.4b26e7c4efd9fa564d80.manager.bundle.js.br +0 -0
- package/demo/{main.f4b9fb997236ae69d894.manager.bundle.js.gz → main.4b26e7c4efd9fa564d80.manager.bundle.js.gz} +0 -0
- package/demo/project.json +1 -1
- package/dist/cjs/utils/micro-frontend/guest.js +4 -3
- package/dist/cjs/utils/micro-frontend/host.js +4 -3
- package/dist/cjs/utils/micro-frontend/index.js +4 -1
- package/dist/cjs/view/guest-microapp.js +14 -4
- package/dist/cjs/view/tests/__snapshots__/micro-iframe-app.test.tsx.snap +2 -2
- package/dist/esm/utils/micro-frontend/guest.js +4 -3
- package/dist/esm/utils/micro-frontend/host.js +4 -3
- package/dist/esm/utils/micro-frontend/index.js +4 -1
- package/dist/esm/view/guest-microapp.js +14 -4
- package/dist/esm/view/tests/__snapshots__/micro-iframe-app.test.tsx.snap +2 -2
- package/dist/types/lib/utils/micro-frontend/guest.d.ts +2 -1
- package/dist/types/lib/utils/micro-frontend/host.d.ts +2 -1
- package/dist/types/lib/utils/micro-frontend/module-so.d.ts +4 -4
- package/dist/types/lib/view/guest-microapp.d.ts +8 -1
- package/dist/types/tsconfig.tsbuildinfo +1 -1
- package/package.json +6 -6
- package/build/docs/404.html +0 -16
- package/build/docs/api/classes/Analytics/index.html +0 -270
- package/build/docs/api/classes/CMicroAppGuest/index.html +0 -261
- package/build/docs/api/classes/CMicroAppHost/index.html +0 -346
- package/build/docs/api/classes/ErrorBoundary/index.html +0 -354
- package/build/docs/api/classes/GuestModule/index.html +0 -148
- package/build/docs/api/functions/AppRoot/index.html +0 -27
- package/build/docs/api/functions/Autocomplete/index.html +0 -22
- package/build/docs/api/functions/CheckBox/index.html +0 -22
- package/build/docs/api/functions/ComboBox/index.html +0 -27
- package/build/docs/api/functions/ComboBoxV3/index.html +0 -22
- package/build/docs/api/functions/ConnectForm/index.html +0 -22
- package/build/docs/api/functions/DateInput/index.html +0 -22
- package/build/docs/api/functions/DatePicker/index.html +0 -27
- package/build/docs/api/functions/DateRangePicker/index.html +0 -22
- package/build/docs/api/functions/DateTimePicker/index.html +0 -22
- package/build/docs/api/functions/Form/index.html +0 -34
- package/build/docs/api/functions/FormItemLayout/index.html +0 -22
- package/build/docs/api/functions/FormLayoutBlockItem/index.html +0 -22
- package/build/docs/api/functions/FormSubmitButton/index.html +0 -22
- package/build/docs/api/functions/InputMask/index.html +0 -22
- package/build/docs/api/functions/InputText/index.html +0 -22
- package/build/docs/api/functions/LargeTextBox/index.html +0 -22
- package/build/docs/api/functions/MaskedInputText/index.html +0 -22
- package/build/docs/api/functions/Page/index.html +0 -22
- package/build/docs/api/functions/Radio/index.html +0 -22
- package/build/docs/api/functions/RadioGroup/index.html +0 -22
- package/build/docs/api/functions/RegisterService/index.html +0 -27
- package/build/docs/api/functions/RenderWithStateAddOns/index.html +0 -22
- package/build/docs/api/functions/RequireAuth/index.html +0 -28
- package/build/docs/api/functions/SessionTimeout/index.html +0 -19
- package/build/docs/api/functions/TextBox/index.html +0 -27
- package/build/docs/api/functions/Toggle/index.html +0 -22
- package/build/docs/api/functions/authSaga/index.html +0 -19
- package/build/docs/api/functions/authorize/index.html +0 -44
- package/build/docs/api/functions/buildModuleParams/index.html +0 -31
- package/build/docs/api/functions/cleanup/index.html +0 -20
- package/build/docs/api/functions/configureStore/index.html +0 -56
- package/build/docs/api/functions/createGuestModule/index.html +0 -39
- package/build/docs/api/functions/createManager/index.html +0 -41
- package/build/docs/api/functions/enableReactAppForHostIntegration/index.html +0 -22
- package/build/docs/api/functions/fetchHostAppData/index.html +0 -24
- package/build/docs/api/functions/fetchUserSettings/index.html +0 -22
- package/build/docs/api/functions/getApiActionCreator/index.html +0 -30
- package/build/docs/api/functions/getAppConfig/index.html +0 -19
- package/build/docs/api/functions/getAppConfigValue/index.html +0 -35
- package/build/docs/api/functions/getAuthHTTPClient/index.html +0 -38
- package/build/docs/api/functions/getAuthorizationHeader/index.html +0 -23
- package/build/docs/api/functions/getHTTPClient/index.html +0 -36
- package/build/docs/api/functions/getHostAppDataByKey/index.html +0 -27
- package/build/docs/api/functions/getLogger/index.html +0 -19
- package/build/docs/api/functions/getMicroFrontEndAppConfig/index.html +0 -23
- package/build/docs/api/functions/getNavigationLinks/index.html +0 -19
- package/build/docs/api/functions/getRedirectUrl/index.html +0 -19
- package/build/docs/api/functions/getSelectField/index.html +0 -33
- package/build/docs/api/functions/getStore/index.html +0 -23
- package/build/docs/api/functions/initServiceWorker/index.html +0 -22
- package/build/docs/api/functions/isCIBuild/index.html +0 -19
- package/build/docs/api/functions/isProd/index.html +0 -19
- package/build/docs/api/functions/isUserAuthorized/index.html +0 -23
- package/build/docs/api/functions/listenStorageEvents/index.html +0 -19
- package/build/docs/api/functions/loadAppConfig/index.html +0 -30
- package/build/docs/api/functions/loadable/index.html +0 -37
- package/build/docs/api/functions/login/index.html +0 -62
- package/build/docs/api/functions/notifyGuestUnloadComplete/index.html +0 -26
- package/build/docs/api/functions/onAuthorizationFailure/index.html +0 -28
- package/build/docs/api/functions/onGuestUnloadStart/index.html +0 -19
- package/build/docs/api/functions/redactPii/index.html +0 -32
- package/build/docs/api/functions/removeDoubleSlash/index.html +0 -22
- package/build/docs/api/functions/removeStorageEvents/index.html +0 -19
- package/build/docs/api/functions/render/index.html +0 -392
- package/build/docs/api/functions/renderHook/index.html +0 -37
- package/build/docs/api/functions/renderWithHostData/index.html +0 -22
- package/build/docs/api/functions/renderWithRedux/index.html +0 -392
- package/build/docs/api/functions/renderWithRouter/index.html +0 -392
- package/build/docs/api/functions/renderWithRouterRedux/index.html +0 -392
- package/build/docs/api/functions/sdkBaseQuery/index.html +0 -37
- package/build/docs/api/functions/sendBAEvent/index.html +0 -34
- package/build/docs/api/functions/sendMessageToHost/index.html +0 -24
- package/build/docs/api/functions/setAppConfig/index.html +0 -27
- package/build/docs/api/functions/setAppConfigValue/index.html +0 -35
- package/build/docs/api/functions/setHostAppData/index.html +0 -25
- package/build/docs/api/functions/setLoginParams/index.html +0 -29
- package/build/docs/api/functions/subscribeToResetSession/index.html +0 -28
- package/build/docs/api/functions/subscribeToSessionExpiry/index.html +0 -28
- package/build/docs/api/functions/subscribeToSessionExpiryWarning/index.html +0 -28
- package/build/docs/api/functions/trackActivity/index.html +0 -31
- package/build/docs/api/functions/useAppDispatch/index.html +0 -24
- package/build/docs/api/functions/useAppMiddleware/index.html +0 -25
- package/build/docs/api/functions/useInjectQuery/index.html +0 -35
- package/build/docs/api/functions/useInjectReducer/index.html +0 -31
- package/build/docs/api/functions/useInjectSaga/index.html +0 -33
- package/build/docs/api/functions/useInjectSideEffect/index.html +0 -25
- package/build/docs/api/functions/useMediaQueryList/index.html +0 -26
- package/build/docs/api/functions/useStateSelector/index.html +0 -38
- package/build/docs/api/functions/useStateSelectorShallow/index.html +0 -39
- package/build/docs/api/functions/waitFor/index.html +0 -27
- package/build/docs/api/functions/waitForElementToBeRemoved/index.html +0 -27
- package/build/docs/api/functions/withAppDecorator/index.html +0 -26
- package/build/docs/api/index.html +0 -29
- package/build/docs/api/interfaces/AppConfig/index.html +0 -46
- package/build/docs/api/interfaces/GuestProps/index.html +0 -86
- package/build/docs/api/interfaces/UseStateSelectorOptions/index.html +0 -25
- package/build/docs/api/type-aliases/AppDispatch/index.html +0 -17
- package/build/docs/api/type-aliases/AppStore/index.html +0 -17
- package/build/docs/api/type-aliases/Await/index.html +0 -20
- package/build/docs/api/type-aliases/EMUI/index.html +0 -62
- package/build/docs/api/type-aliases/HostOptions/index.html +0 -28
- package/build/docs/api/type-aliases/HostProvidedParams/index.html +0 -33
- package/build/docs/api/type-aliases/ModuleOverrides/index.html +0 -47
- package/build/docs/api/type-aliases/OnHostInitCallback/index.html +0 -22
- package/build/docs/api/type-aliases/OnInitCallback/index.html +0 -22
- package/build/docs/api/type-aliases/OnMountCallback/index.html +0 -22
- package/build/docs/api/type-aliases/OnUnMountCallback/index.html +0 -22
- package/build/docs/api/type-aliases/RootState/index.html +0 -17
- package/build/docs/api/type-aliases/SelectStateFieldFunction/index.html +0 -29
- package/build/docs/api/variables/ErrorToast/index.html +0 -17
- package/build/docs/api/variables/FormPropsContext/index.html +0 -24
- package/build/docs/api/variables/GuestMicroApp/index.html +0 -20
- package/build/docs/api/variables/MASK_PIPES/index.html +0 -17
- package/build/docs/api/variables/MASK_TYPES/index.html +0 -17
- package/build/docs/api/variables/MicroApp/index.html +0 -21
- package/build/docs/api/variables/MicroIFrameApp/index.html +0 -21
- package/build/docs/api/variables/NavigationPrompt/index.html +0 -17
- package/build/docs/api/variables/NavigationPromptActions/index.html +0 -22
- package/build/docs/api/variables/Themes/index.html +0 -22
- package/build/docs/api/variables/VisuallyHidden/index.html +0 -17
- package/build/docs/api/variables/WaitMessage/index.html +0 -17
- package/build/docs/api/variables/act/index.html +0 -20
- package/build/docs/api/variables/ariaLive/index.html +0 -17
- package/build/docs/api/variables/auth/index.html +0 -40
- package/build/docs/api/variables/authReducer/index.html +0 -17
- package/build/docs/api/variables/clearSideEffects/index.html +0 -21
- package/build/docs/api/variables/createSideEffect/index.html +0 -19
- package/build/docs/api/variables/decorators/index.html +0 -222
- package/build/docs/api/variables/endSession/index.html +0 -37
- package/build/docs/api/variables/error/index.html +0 -17
- package/build/docs/api/variables/errorMiddleware/index.html +0 -17
- package/build/docs/api/variables/fireEvent/index.html +0 -17
- package/build/docs/api/variables/globalConstants/index.html +0 -22
- package/build/docs/api/variables/history/index.html +0 -17
- package/build/docs/api/variables/httpClientProps/index.html +0 -17
- package/build/docs/api/variables/logout/index.html +0 -22
- package/build/docs/api/variables/memoryHistory/index.html +0 -17
- package/build/docs/api/variables/removeSideEffect/index.html +0 -20
- package/build/docs/api/variables/resetUserIdleTime/index.html +0 -23
- package/build/docs/api/variables/screen/index.html +0 -17
- package/build/docs/api/variables/startSideEffect/index.html +0 -21
- package/build/docs/api/variables/updateBAEventParameters/index.html +0 -27
- package/build/docs/api/variables/useAppSelector/index.html +0 -21
- package/build/docs/api/variables/waitMessageAction/index.html +0 -43
- package/build/docs/api/variables/within/index.html +0 -17
- package/build/docs/assets/css/styles.0fad824b.css +0 -1
- package/build/docs/assets/js/04ee7372.a9b3e0ad.js +0 -1
- package/build/docs/assets/js/05fd5745.f77a9872.js +0 -1
- package/build/docs/assets/js/075aa584.dde55d25.js +0 -1
- package/build/docs/assets/js/0a1bd0e5.3336afb7.js +0 -1
- package/build/docs/assets/js/0f302db7.690bba2c.js +0 -1
- package/build/docs/assets/js/10c70e6f.3a611c9f.js +0 -1
- package/build/docs/assets/js/110b6cba.2039a4be.js +0 -1
- package/build/docs/assets/js/1126.2b1e83b8.js +0 -1
- package/build/docs/assets/js/1127.ce24a599.js +0 -1
- package/build/docs/assets/js/1154937a.58ab70e0.js +0 -1
- package/build/docs/assets/js/1298.f98e394e.js +0 -1
- package/build/docs/assets/js/14efea89.c724a605.js +0 -1
- package/build/docs/assets/js/15f40f8f.62fbc501.js +0 -1
- package/build/docs/assets/js/1617.443ab77e.js +0 -1
- package/build/docs/assets/js/16427680.5a41da14.js +0 -1
- package/build/docs/assets/js/16fba083.0c978e4b.js +0 -1
- package/build/docs/assets/js/1700.bb38b1b9.js +0 -1
- package/build/docs/assets/js/17896441.87af09c7.js +0 -1
- package/build/docs/assets/js/1a5ba401.bdd09a56.js +0 -1
- package/build/docs/assets/js/1ad86f56.5c4d3ed7.js +0 -1
- package/build/docs/assets/js/1cc7c915.18a50af2.js +0 -1
- package/build/docs/assets/js/1dfec420.e8ed9238.js +0 -1
- package/build/docs/assets/js/1fcf59a8.501bb96b.js +0 -1
- package/build/docs/assets/js/2026.f4b8efbd.js +0 -1
- package/build/docs/assets/js/213.07804718.js +0 -1
- package/build/docs/assets/js/2297.998393a9.js +0 -1
- package/build/docs/assets/js/22c6ac39.38c10213.js +0 -1
- package/build/docs/assets/js/242.98ba961c.js +0 -1
- package/build/docs/assets/js/247.f91b8960.js +0 -1
- package/build/docs/assets/js/24b1c163.4390b04b.js +0 -1
- package/build/docs/assets/js/25ae0bf1.3ff15c6f.js +0 -1
- package/build/docs/assets/js/2673.1111af38.js +0 -1
- package/build/docs/assets/js/27c4a013.bceaff37.js +0 -1
- package/build/docs/assets/js/27c8b774.1ec1881a.js +0 -1
- package/build/docs/assets/js/2805.21b4fb8d.js +0 -1
- package/build/docs/assets/js/2b2c5b3b.41587ade.js +0 -1
- package/build/docs/assets/js/3072782a.825cd627.js +0 -1
- package/build/docs/assets/js/3204d46b.7af2b3bd.js +0 -1
- package/build/docs/assets/js/322ec2e7.529db700.js +0 -1
- package/build/docs/assets/js/336f5910.34c060aa.js +0 -1
- package/build/docs/assets/js/3395.f8117aa5.js +0 -1
- package/build/docs/assets/js/3499.2c20c6ff.js +0 -1
- package/build/docs/assets/js/3552.2d0559a3.js +0 -1
- package/build/docs/assets/js/365a2c17.6afbd7ba.js +0 -1
- package/build/docs/assets/js/379bbc32.cfc06360.js +0 -1
- package/build/docs/assets/js/3992.aa5529d1.js +0 -2
- package/build/docs/assets/js/3992.aa5529d1.js.LICENSE.txt +0 -1
- package/build/docs/assets/js/3accd241.850fb650.js +0 -1
- package/build/docs/assets/js/3b0e1261.9caf419d.js +0 -1
- package/build/docs/assets/js/3b333d5b.831324f6.js +0 -1
- package/build/docs/assets/js/3cb0b0a9.99866080.js +0 -1
- package/build/docs/assets/js/3cd01694.04367956.js +0 -1
- package/build/docs/assets/js/4069.77c5dcc9.js +0 -1
- package/build/docs/assets/js/4134.d6069e6e.js +0 -1
- package/build/docs/assets/js/413bfdf1.2e754bf4.js +0 -1
- package/build/docs/assets/js/41f4ce7f.8662231d.js +0 -1
- package/build/docs/assets/js/4257.60660403.js +0 -1
- package/build/docs/assets/js/46eb403d.e5123d24.js +0 -1
- package/build/docs/assets/js/4772.988b91f1.js +0 -1
- package/build/docs/assets/js/4780.8d49dc64.js +0 -1
- package/build/docs/assets/js/47f7a134.2369c86a.js +0 -1
- package/build/docs/assets/js/4884.48d16d5b.js +0 -1
- package/build/docs/assets/js/4acce17e.b84485e3.js +0 -1
- package/build/docs/assets/js/4b10ac31.ffdbb394.js +0 -1
- package/build/docs/assets/js/4eef183e.99934dfe.js +0 -1
- package/build/docs/assets/js/50ae2c89.ea85453c.js +0 -1
- package/build/docs/assets/js/50b500dc.b1dafbf4.js +0 -1
- package/build/docs/assets/js/5113883b.19fc9d2f.js +0 -1
- package/build/docs/assets/js/5196.dda420ed.js +0 -1
- package/build/docs/assets/js/51cd08ce.eedf6a77.js +0 -1
- package/build/docs/assets/js/5248.5442863c.js +0 -1
- package/build/docs/assets/js/533e434c.6a22f28d.js +0 -1
- package/build/docs/assets/js/53defe29.b34f5bfe.js +0 -1
- package/build/docs/assets/js/5428.28b1d8b6.js +0 -1
- package/build/docs/assets/js/54dea6f0.7b5fa5e6.js +0 -1
- package/build/docs/assets/js/550f7dc1.a569914a.js +0 -1
- package/build/docs/assets/js/5575829c.04c44eb2.js +0 -1
- package/build/docs/assets/js/58e12487.6e6066d3.js +0 -1
- package/build/docs/assets/js/59169cbb.2d2d02ce.js +0 -1
- package/build/docs/assets/js/5964.fbd55ce8.js +0 -1
- package/build/docs/assets/js/5968.7a565a4e.js +0 -1
- package/build/docs/assets/js/5c5cf8ae.cf6912f5.js +0 -1
- package/build/docs/assets/js/5ca2639d.8b06c9ea.js +0 -1
- package/build/docs/assets/js/5da011d0.872006f0.js +0 -1
- package/build/docs/assets/js/5e13701d.8a6b7fd6.js +0 -1
- package/build/docs/assets/js/5e7ee35c.01ca7414.js +0 -1
- package/build/docs/assets/js/5e8c322a.0391dec4.js +0 -1
- package/build/docs/assets/js/5e95c892.f11d5bd6.js +0 -1
- package/build/docs/assets/js/5ebc190f.49776b06.js +0 -1
- package/build/docs/assets/js/5f21eb71.536ccef3.js +0 -1
- package/build/docs/assets/js/60781fed.87f57230.js +0 -1
- package/build/docs/assets/js/61b0e64b.c86eca9e.js +0 -1
- package/build/docs/assets/js/61f3b5cc.197d138c.js +0 -1
- package/build/docs/assets/js/62e1e335.d54d1d6e.js +0 -1
- package/build/docs/assets/js/6486.776625d1.js +0 -1
- package/build/docs/assets/js/6611.481d87ff.js +0 -2
- package/build/docs/assets/js/6611.481d87ff.js.LICENSE.txt +0 -9
- package/build/docs/assets/js/6aac2d5c.95d7104d.js +0 -1
- package/build/docs/assets/js/6b345055.f4f6c3b9.js +0 -1
- package/build/docs/assets/js/6b7fcc15.290796d9.js +0 -1
- package/build/docs/assets/js/6ca90961.8833c635.js +0 -1
- package/build/docs/assets/js/6d1f0509.55213557.js +0 -1
- package/build/docs/assets/js/6daa33e8.c1c74588.js +0 -1
- package/build/docs/assets/js/7080.73a89c35.js +0 -1
- package/build/docs/assets/js/7201.26026979.js +0 -1
- package/build/docs/assets/js/7344.12628cac.js +0 -1
- package/build/docs/assets/js/749b3cb7.660b1c4b.js +0 -1
- package/build/docs/assets/js/7516.78c3385c.js +0 -1
- package/build/docs/assets/js/7525.69d857f8.js +0 -1
- package/build/docs/assets/js/7540.ee4aa270.js +0 -1
- package/build/docs/assets/js/78fde597.9598cb2a.js +0 -1
- package/build/docs/assets/js/7985.6aac4971.js +0 -1
- package/build/docs/assets/js/7b224b5a.d21317ac.js +0 -1
- package/build/docs/assets/js/7c822e85.3cc0a954.js +0 -1
- package/build/docs/assets/js/7cde3459.802fae28.js +0 -1
- package/build/docs/assets/js/7d256524.087a46e5.js +0 -1
- package/build/docs/assets/js/7d48b3e7.5d6ce912.js +0 -1
- package/build/docs/assets/js/80392bdc.dbd30f9e.js +0 -1
- package/build/docs/assets/js/8049.5b4457b0.js +0 -1
- package/build/docs/assets/js/805daf1e.305437dc.js +0 -1
- package/build/docs/assets/js/8152.32ad98ca.js +0 -1
- package/build/docs/assets/js/821.19f6a696.js +0 -1
- package/build/docs/assets/js/822e0178.3c0d623a.js +0 -1
- package/build/docs/assets/js/82894961.81f97aaf.js +0 -1
- package/build/docs/assets/js/8290.f0834113.js +0 -1
- package/build/docs/assets/js/8355.bcde11e0.js +0 -1
- package/build/docs/assets/js/8389.b3f6164d.js +0 -1
- package/build/docs/assets/js/8585.e50595e8.js +0 -1
- package/build/docs/assets/js/85dc4c9b.d835c54a.js +0 -1
- package/build/docs/assets/js/8788.c86aea45.js +0 -1
- package/build/docs/assets/js/88a4c043.ca8fd05b.js +0 -1
- package/build/docs/assets/js/90579cbd.0835e6a5.js +0 -1
- package/build/docs/assets/js/90bbfd1d.d0fd53f0.js +0 -1
- package/build/docs/assets/js/9178.f2e05b02.js +0 -1
- package/build/docs/assets/js/9210.b5a9980e.js +0 -1
- package/build/docs/assets/js/9354.77e86f51.js +0 -1
- package/build/docs/assets/js/936.275fbed5.js +0 -1
- package/build/docs/assets/js/9550cc1f.e19e7779.js +0 -1
- package/build/docs/assets/js/9574.c7203040.js +0 -1
- package/build/docs/assets/js/97.d2ed6ba9.js +0 -1
- package/build/docs/assets/js/9852.cf8f89a9.js +0 -1
- package/build/docs/assets/js/9953.90bfd954.js +0 -1
- package/build/docs/assets/js/999f4a99.31e9f0f9.js +0 -1
- package/build/docs/assets/js/99a35e8f.3cb224e6.js +0 -1
- package/build/docs/assets/js/9ab62f73.a44012b0.js +0 -1
- package/build/docs/assets/js/9ea6fe4d.ebd612bc.js +0 -1
- package/build/docs/assets/js/a09470d9.16bfeef9.js +0 -1
- package/build/docs/assets/js/a0eb976e.f6504d94.js +0 -1
- package/build/docs/assets/js/a17fb045.0c651699.js +0 -1
- package/build/docs/assets/js/a2537f00.c241e3f2.js +0 -1
- package/build/docs/assets/js/a29a6e44.58d6b878.js +0 -1
- package/build/docs/assets/js/a3ecf861.0f55d8fd.js +0 -1
- package/build/docs/assets/js/a48fd09c.50989621.js +0 -1
- package/build/docs/assets/js/a6c41565.0821af7d.js +0 -1
- package/build/docs/assets/js/a6c5c03c.0e69962a.js +0 -1
- package/build/docs/assets/js/a769954d.02ea4cc3.js +0 -1
- package/build/docs/assets/js/a7861986.e4d90417.js +0 -1
- package/build/docs/assets/js/a7bd4aaa.3faf623f.js +0 -1
- package/build/docs/assets/js/a8687130.681fc6b9.js +0 -1
- package/build/docs/assets/js/a94703ab.9865def5.js +0 -1
- package/build/docs/assets/js/a9ba6591.bcdf3f9d.js +0 -1
- package/build/docs/assets/js/ab05b3aa.63cf7d9f.js +0 -1
- package/build/docs/assets/js/aba21aa0.4d968e31.js +0 -1
- package/build/docs/assets/js/ac9d64ec.dd98824b.js +0 -1
- package/build/docs/assets/js/aeb9810c.f3c24439.js +0 -1
- package/build/docs/assets/js/b0125fa2.c7fba4da.js +0 -1
- package/build/docs/assets/js/b0ccf0d8.89a4a7e2.js +0 -1
- package/build/docs/assets/js/b1474780.0982f737.js +0 -1
- package/build/docs/assets/js/b2a255cc.df3fdd56.js +0 -1
- package/build/docs/assets/js/b31a5f55.9a4737ac.js +0 -1
- package/build/docs/assets/js/b4285021.67b039a1.js +0 -1
- package/build/docs/assets/js/b784b5bb.7d7bb82c.js +0 -1
- package/build/docs/assets/js/b8c1226b.a92653b3.js +0 -1
- package/build/docs/assets/js/b93b454c.f87b4896.js +0 -1
- package/build/docs/assets/js/bc717899.36b37795.js +0 -1
- package/build/docs/assets/js/bf1a96cc.8abf8470.js +0 -1
- package/build/docs/assets/js/c10ec81d.0dff1cac.js +0 -1
- package/build/docs/assets/js/c254daed.d6764cd8.js +0 -1
- package/build/docs/assets/js/c377a04b.a6a0a334.js +0 -1
- package/build/docs/assets/js/c52b5473.1a1069c1.js +0 -1
- package/build/docs/assets/js/c5e9787b.448cc7d9.js +0 -1
- package/build/docs/assets/js/c7710052.d061cfdd.js +0 -1
- package/build/docs/assets/js/c8a9fc86.daf30d50.js +0 -1
- package/build/docs/assets/js/c90572d4.42231642.js +0 -1
- package/build/docs/assets/js/cfad4bb4.edde6aa3.js +0 -1
- package/build/docs/assets/js/d071c513.a096e87e.js +0 -1
- package/build/docs/assets/js/d0fd4a71.1d53f49d.js +0 -1
- package/build/docs/assets/js/d1d7a857.424e14dc.js +0 -1
- package/build/docs/assets/js/d38c25bf.1430a667.js +0 -1
- package/build/docs/assets/js/d3d37933.d7f15fe8.js +0 -1
- package/build/docs/assets/js/d71e6c8a.f4306e16.js +0 -1
- package/build/docs/assets/js/d9084ecb.61eb0649.js +0 -1
- package/build/docs/assets/js/de3ee31a.0992aa16.js +0 -1
- package/build/docs/assets/js/e0db4c79.6fcade57.js +0 -1
- package/build/docs/assets/js/e4ad89b2.9ca87caa.js +0 -1
- package/build/docs/assets/js/e876cff6.7c7560ed.js +0 -1
- package/build/docs/assets/js/e917d7c9.b54a542b.js +0 -1
- package/build/docs/assets/js/e9f568e8.b96fc01f.js +0 -1
- package/build/docs/assets/js/ea5986e4.ff0e5037.js +0 -1
- package/build/docs/assets/js/eb84a108.be29052f.js +0 -1
- package/build/docs/assets/js/ed6a4585.c5d8bf90.js +0 -1
- package/build/docs/assets/js/f4180cff.dae060fd.js +0 -1
- package/build/docs/assets/js/f7084923.91b0c545.js +0 -1
- package/build/docs/assets/js/f72a372a.4118877c.js +0 -1
- package/build/docs/assets/js/f72c86d0.d74270de.js +0 -1
- package/build/docs/assets/js/f8fa0321.c4c3a620.js +0 -1
- package/build/docs/assets/js/fc7c782f.bc0ad1ab.js +0 -1
- package/build/docs/assets/js/fce396bf.9f7f818c.js +0 -1
- package/build/docs/assets/js/fdb0d9e1.d2893206.js +0 -1
- package/build/docs/assets/js/fed4ae4f.e788c07f.js +0 -1
- package/build/docs/assets/js/fefe9566.113c5960.js +0 -1
- package/build/docs/assets/js/ff0bf96e.e457283e.js +0 -1
- package/build/docs/assets/js/ff6d65a9.39317a08.js +0 -1
- package/build/docs/assets/js/main.7d445fc8.js +0 -2
- package/build/docs/assets/js/main.7d445fc8.js.LICENSE.txt +0 -51
- package/build/docs/assets/js/runtime~main.5c8a1e20.js +0 -1
- package/build/docs/img/favicon.ico +0 -0
- package/build/docs/img/logo.jpeg +0 -0
- package/build/docs/img/logo.svg +0 -22
- package/build/docs/img/readme.md +0 -1
- package/build/docs/index.html +0 -102
- package/build/docs/readme.md +0 -1
- package/build/docs/sitemap.xml +0 -1
- package/build/docs/usage-guide/index.html +0 -580
- package/demo/6879.3434f1e9.iframe.bundle.js.br +0 -0
- package/demo/6879.3434f1e9.iframe.bundle.js.gz +0 -0
- package/demo/docs/6879.3434f1e9.iframe.bundle.js.br +0 -0
- package/demo/docs/6879.3434f1e9.iframe.bundle.js.gz +0 -0
- package/demo/docs/main.703b0e4c.iframe.bundle.js +0 -5
- package/demo/docs/main.703b0e4c.iframe.bundle.js.br +0 -0
- package/demo/docs/main.703b0e4c.iframe.bundle.js.gz +0 -0
- package/demo/docs/main.f4b9fb997236ae69d894.manager.bundle.js.br +0 -0
- package/demo/main.703b0e4c.iframe.bundle.js +0 -5
- package/demo/main.703b0e4c.iframe.bundle.js.br +0 -0
- package/demo/main.703b0e4c.iframe.bundle.js.gz +0 -0
- package/demo/main.f4b9fb997236ae69d894.manager.bundle.js.br +0 -0
|
@@ -1,270 +0,0 @@
|
|
|
1
|
-
<!doctype html>
|
|
2
|
-
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-api/classes/Analytics" data-has-hydrated="false">
|
|
3
|
-
<head>
|
|
4
|
-
<meta charset="UTF-8">
|
|
5
|
-
<meta name="generator" content="Docusaurus v3.10.1">
|
|
6
|
-
<title data-rh="true">Analytics | 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/classes/Analytics"><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="Analytics | App SDK"><meta data-rh="true" name="description" content="Analytics scripting object that captures business analytics events and"><meta data-rh="true" property="og:description" content="Analytics scripting object that captures business analytics events and"><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/classes/Analytics"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/classes/Analytics" hreflang="en"><link data-rh="true" rel="alternate" href="https://pui.ice.com/app-sdk/api/classes/Analytics" 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":"Analytics","item":"https://pui.ice.com/app-sdk/api/classes/Analytics"}]}</script><link rel="stylesheet" href="/app-sdk/assets/css/styles.0fad824b.css">
|
|
7
|
-
<script src="/app-sdk/assets/js/runtime~main.5c8a1e20.js" defer="defer"></script>
|
|
8
|
-
<script src="/app-sdk/assets/js/main.7d445fc8.js" defer="defer"></script>
|
|
9
|
-
</head>
|
|
10
|
-
<body>
|
|
11
|
-
<svg style="display: none;"><defs>
|
|
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
|
-
</defs></svg>
|
|
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_JAhZ" 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_SSxs themedComponent--light_SZPQ"><img src="/app-sdk/img/logo.svg" alt="App SDK" class="themedComponent_SSxs themedComponent--dark_komm"></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_uxYp"><use href="#theme-svg-external-link"></use></svg></a><div class="toggle_h793 colorModeToggle_v_2a"><button class="clean-btn toggleButton_luUl toggleButtonDisabled_cKAk" 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_DcpM lightToggleIcon_kcXC"><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_DcpM darkToggleIcon_ZFgA"><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_DcpM systemToggleIcon_v1mL"><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_S02n"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_Zl5R"><div class="docsWrapper_ueFZ"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_ODdz" type="button"></button><div class="docRoot_hEeJ"><aside class="theme-doc-sidebar-container docSidebarContainer_iMMY"><div class="sidebarViewport_qKht"><div class="sidebar_pQSv"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_rgip"><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_nibH menu__link menu__link--sublist menu__link--active" href="/app-sdk/api/"><span title="App SDK API" class="categoryLinkLabel_IX6H">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"><div class="menu__list-item-collapsible"><a class="categoryLink_nibH menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/app-sdk/api/classes/Analytics"><span title="classes" class="categoryLinkLabel_IX6H">classes</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 menu__link--active" aria-current="page" tabindex="0" href="/app-sdk/api/classes/Analytics"><span title="Analytics" class="linkLabel_Jzo_">Analytics</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/classes/CMicroAppGuest"><span title="CMicroAppGuest\<AppObjects, AppEvents\>" class="linkLabel_Jzo_">CMicroAppGuest\<AppObjects, AppEvents\></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/classes/CMicroAppHost"><span title="~~CMicroAppHost\<AppObjects, AppEvents\>~~" class="linkLabel_Jzo_">~~CMicroAppHost\<AppObjects, AppEvents\>~~</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/classes/ErrorBoundary"><span title="ErrorBoundary" class="linkLabel_Jzo_">ErrorBoundary</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/classes/GuestModule"><span title="GuestModule" class="linkLabel_Jzo_">GuestModule</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_nibH menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/app-sdk/api/functions/AppRoot"><span title="functions" class="categoryLinkLabel_IX6H">functions</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_nibH 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_IX6H">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_nibH 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_IX6H">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_nibH 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_IX6H">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_Jzo_">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_Jzo_">Usage Guide</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_Ww0q"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_nUXI"><div class="docItemContainer_Lld7"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z125" 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_keIu"><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">classes</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">Analytics</span></li></ul></nav><div class="tocCollapsible_iI5M theme-doc-toc-mobile tocMobile_IiaZ"><button type="button" class="clean-btn tocCollapsibleButton_IsfN">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Analytics</h1></header>
|
|
15
|
-
<p>Analytics scripting object that captures business analytics events and
|
|
16
|
-
performance timing measurements, forwarding them to multiple destinations.</p>
|
|
17
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="destinations">Destinations<a href="#destinations" class="hash-link" aria-label="Direct link to Destinations" title="Direct link to Destinations" translate="no"></a></h2>
|
|
18
|
-
<table><thead><tr><th>Destination</th><th>Transport</th><th>What it receives</th></tr></thead><tbody><tr><td><strong>Splunk</strong></td><td><code>logger.info()</code></td><td>Timing events only — <code>message</code>, <code>event</code>, <code>duration</code>, <code>startTime</code>, <code>detail</code></td></tr><tr><td><strong>GTM</strong></td><td><code>window.gtmDataLayer.push()</code></td><td>BA events and timing events — full enriched payload (BA params + product details + caller data)</td></tr><tr><td><strong>LogRocket</strong></td><td><code>logRocket.track()</code> via lrTrackGuarded</td><td>BA events only: caller-supplied fields</td></tr></tbody></table>
|
|
19
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="use-cases">Use cases<a href="#use-cases" class="hash-link" aria-label="Direct link to Use cases" title="Direct link to Use cases" translate="no"></a></h2>
|
|
20
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="1-business-analytics-events-sendbaevent">1. Business analytics events (<code>sendBAEvent</code>)<a href="#1-business-analytics-events-sendbaevent" class="hash-link" aria-label="Direct link to 1-business-analytics-events-sendbaevent" title="Direct link to 1-business-analytics-events-sendbaevent" translate="no"></a></h3>
|
|
21
|
-
<p>Fire-and-forget event tracking for user actions, page views, feature usage,
|
|
22
|
-
errors, etc. No sampling — every call reaches GTM and LogRocket (subject to
|
|
23
|
-
LR throttle). GTM receives the full enriched context; LogRocket receives
|
|
24
|
-
only the caller-supplied fields to conserve its 2,000-property session budget.</p>
|
|
25
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="2-manual-performance-timing-starttiming--endtiming">2. Manual performance timing (<code>startTiming</code> / <code>endTiming</code>)<a href="#2-manual-performance-timing-starttiming--endtiming" class="hash-link" aria-label="Direct link to 2-manual-performance-timing-starttiming--endtiming" title="Direct link to 2-manual-performance-timing-starttiming--endtiming" translate="no"></a></h3>
|
|
26
|
-
<p>Bracket a unit of work to measure its wall-clock duration. <code>startTiming</code>
|
|
27
|
-
creates a <code>performance.mark()</code>; <code>endTiming</code> calls <code>performance.measure()</code>
|
|
28
|
-
which is then picked up by the automatic pipeline (use case 3).</p>
|
|
29
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="3-automatic-performance-observation-monitorperformance">3. Automatic performance observation (<code>#monitorPerformance</code>)<a href="#3-automatic-performance-observation-monitorperformance" class="hash-link" aria-label="Direct link to 3-automatic-performance-observation-monitorperformance" title="Direct link to 3-automatic-performance-observation-monitorperformance" translate="no"></a></h3>
|
|
30
|
-
<p>A page-wide <code>PerformanceObserver</code> captures every <code>performance.measure()</code>
|
|
31
|
-
entry — including those from <code>endTiming</code> and any other code on the page.
|
|
32
|
-
Each entry passes through:</p>
|
|
33
|
-
<ol>
|
|
34
|
-
<li class=""><strong>Third-party filter</strong> — GTM/GA4 internal measures (names matching
|
|
35
|
-
<code>GTM-*</code> or <code>G-*</code>) are silently dropped.</li>
|
|
36
|
-
<li class=""><strong>Head sampling</strong> — per-event-name ratio (default 25%) decides whether
|
|
37
|
-
to record. Configurable via <code>setTimingEventSamplingRatio</code>.</li>
|
|
38
|
-
<li class=""><strong>Fan-out</strong> — sampled entries are sent to Splunk and GTM.
|
|
39
|
-
Processing is deferred via <code>queueMicrotask</code> so the caller's
|
|
40
|
-
<code>performance.measure()</code> returns immediately.</li>
|
|
41
|
-
</ol>
|
|
42
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="4-sampling-ratio-management">4. Sampling ratio management<a href="#4-sampling-ratio-management" class="hash-link" aria-label="Direct link to 4. Sampling ratio management" title="Direct link to 4. Sampling ratio management" translate="no"></a></h3>
|
|
43
|
-
<p>Runtime CRUD for per-event sampling ratios via <code>setTimingEventSamplingRatio</code>,
|
|
44
|
-
<code>getTimingEventSamplingRatio</code>, <code>deleteTimingEventSamplingRatio</code>, and
|
|
45
|
-
<code>getAllTimingEventSamplingRatios</code>. Sampling applies uniformly to both
|
|
46
|
-
timing destinations (Splunk and GTM) — there is no per-destination sampling.</p>
|
|
47
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="example">Example<a href="#example" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h2>
|
|
48
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> analytics </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> </span><span class="token class-name">Analytics</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> logger</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> timingEventSamplingRatios</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><span class="token string-property property" style="color:#36acaa">'api-call'</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string-property property" style="color:#36acaa">'page-load'</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.0</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div 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 punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Business event</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">sendBAEvent</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> event</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'user-login'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> method</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'oauth'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Timing measurement</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> mark </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">startTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'api-call'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'svc'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> location</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">href </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">fetchData</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">endTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">mark</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'svc'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> location</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">href </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
49
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="extends">Extends<a href="#extends" class="hash-link" aria-label="Direct link to Extends" title="Direct link to Extends" translate="no"></a></h2>
|
|
50
|
-
<ul>
|
|
51
|
-
<li class=""><code>ScriptingObject</code></li>
|
|
52
|
-
</ul>
|
|
53
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="implements">Implements<a href="#implements" class="hash-link" aria-label="Direct link to Implements" title="Direct link to Implements" translate="no"></a></h2>
|
|
54
|
-
<ul>
|
|
55
|
-
<li class=""><code>IAnalytics</code></li>
|
|
56
|
-
</ul>
|
|
57
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="accessors">Accessors<a href="#accessors" class="hash-link" aria-label="Direct link to Accessors" title="Direct link to Accessors" translate="no"></a></h2>
|
|
58
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="id">id<a href="#id" class="hash-link" aria-label="Direct link to id" title="Direct link to id" translate="no"></a></h3>
|
|
59
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="get-signature">Get Signature<a href="#get-signature" class="hash-link" aria-label="Direct link to Get Signature" title="Direct link to Get Signature" translate="no"></a></h4>
|
|
60
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">get</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">id</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">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
61
|
-
<p>get unique id of the scripting object</p>
|
|
62
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="returns">Returns<a href="#returns" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h5>
|
|
63
|
-
<p><code>string</code></p>
|
|
64
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of">Implementation of<a href="#implementation-of" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
65
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">id</span><br></div></code></pre></div></div>
|
|
66
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from">Inherited from<a href="#inherited-from" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
|
|
67
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">ScriptingObject</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">id</span><br></div></code></pre></div></div>
|
|
68
|
-
<hr>
|
|
69
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="objecttype">objectType<a href="#objecttype" class="hash-link" aria-label="Direct link to objectType" title="Direct link to objectType" translate="no"></a></h3>
|
|
70
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="get-signature-1">Get Signature<a href="#get-signature-1" class="hash-link" aria-label="Direct link to Get Signature" title="Direct link to Get Signature" translate="no"></a></h4>
|
|
71
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">get</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">objectType</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">string</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
72
|
-
<p>get type of the scripting object</p>
|
|
73
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-1">Returns<a href="#returns-1" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h5>
|
|
74
|
-
<p><code>string</code></p>
|
|
75
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-1">Implementation of<a href="#implementation-of-1" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
76
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">objectType</span><br></div></code></pre></div></div>
|
|
77
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-1">Inherited from<a href="#inherited-from-1" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
|
|
78
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">ScriptingObject</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">objectType</span><br></div></code></pre></div></div>
|
|
79
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="constructors">Constructors<a href="#constructors" class="hash-link" aria-label="Direct link to Constructors" title="Direct link to Constructors" translate="no"></a></h2>
|
|
80
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="constructor">Constructor<a href="#constructor" class="hash-link" aria-label="Direct link to Constructor" title="Direct link to Constructor" translate="no"></a></h3>
|
|
81
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">new</span><span class="token plain"> </span><span class="token class-name">Analytics</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"> AnalyticsParams</span><span class="token punctuation" style="color:#393A34">)</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Analytics</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
82
|
-
<p>Creates a new Analytics scripting object and immediately starts the
|
|
83
|
-
page-wide PerformanceObserver for timing events.</p>
|
|
84
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="parameters">Parameters<a href="#parameters" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
|
|
85
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="params">params<a href="#params" class="hash-link" aria-label="Direct link to params" title="Direct link to params" translate="no"></a></h5>
|
|
86
|
-
<p><code>AnalyticsParams</code></p>
|
|
87
|
-
<p>Analytics configuration</p>
|
|
88
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-2">Returns<a href="#returns-2" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
89
|
-
<p><code>Analytics</code></p>
|
|
90
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="overrides">Overrides<a href="#overrides" class="hash-link" aria-label="Direct link to Overrides" title="Direct link to Overrides" translate="no"></a></h4>
|
|
91
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">ScriptingObject</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">constructor</span><br></div></code></pre></div></div>
|
|
92
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="properties">Properties<a href="#properties" class="hash-link" aria-label="Direct link to Properties" title="Direct link to Properties" translate="no"></a></h2>
|
|
93
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="_dispose">_dispose<a href="#_dispose" class="hash-link" aria-label="Direct link to _dispose" title="Direct link to _dispose" translate="no"></a></h3>
|
|
94
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">_dispose</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 punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=></span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">void</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
95
|
-
<p>dispose the scripting object</p>
|
|
96
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-3">Returns<a href="#returns-3" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
97
|
-
<p><code>void</code></p>
|
|
98
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-2">Implementation of<a href="#implementation-of-2" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
99
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_dispose</span><br></div></code></pre></div></div>
|
|
100
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-2">Inherited from<a href="#inherited-from-2" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
|
|
101
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">ScriptingObject</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_dispose</span><br></div></code></pre></div></div>
|
|
102
|
-
<hr>
|
|
103
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="_tojson">_toJSON<a href="#_tojson" class="hash-link" aria-label="Direct link to _toJSON" title="Direct link to _toJSON" translate="no"></a></h3>
|
|
104
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">_toJSON</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 punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=></span><span class="token plain"> RemotingScriptingObject</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
105
|
-
<p>transform the scripting object to a format suitable for transmitting over window.postMessage</p>
|
|
106
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-4">Returns<a href="#returns-4" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
107
|
-
<p><code>RemotingScriptingObject</code></p>
|
|
108
|
-
<p>marshalled scripting object</p>
|
|
109
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-3">Implementation of<a href="#implementation-of-3" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
110
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_toJSON</span><br></div></code></pre></div></div>
|
|
111
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-3">Inherited from<a href="#inherited-from-3" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
|
|
112
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">ScriptingObject</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">_toJSON</span><br></div></code></pre></div></div>
|
|
113
|
-
<hr>
|
|
114
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="deletetimingeventsamplingratio">deleteTimingEventSamplingRatio<a href="#deletetimingeventsamplingratio" class="hash-link" aria-label="Direct link to deleteTimingEventSamplingRatio" title="Direct link to deleteTimingEventSamplingRatio" translate="no"></a></h3>
|
|
115
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">deleteTimingEventSamplingRatio</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">names</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 punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=></span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">void</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
116
|
-
<p>Remove explicit sampling configuration for the given timing event names.</p>
|
|
117
|
-
<p>After deletion the events revert to the default ratio of 0.25 (25%).
|
|
118
|
-
Deleting a name that was never configured is a no-op.</p>
|
|
119
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="parameters-1">Parameters<a href="#parameters-1" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
|
|
120
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="names">names<a href="#names" class="hash-link" aria-label="Direct link to names" title="Direct link to names" translate="no"></a></h5>
|
|
121
|
-
<p><code>string</code>[]</p>
|
|
122
|
-
<p>Array of event names whose ratios should be removed</p>
|
|
123
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-5">Returns<a href="#returns-5" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
124
|
-
<p><code>void</code></p>
|
|
125
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="example-1">Example<a href="#example-1" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
|
126
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">deleteTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">'api-call'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'user-interaction'</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Both now sample at the default 25%</span><br></div></code></pre></div></div>
|
|
127
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-4">Implementation of<a href="#implementation-of-4" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
128
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">deleteTimingEventSamplingRatio</span><br></div></code></pre></div></div>
|
|
129
|
-
<hr>
|
|
130
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="dispose">dispose<a href="#dispose" class="hash-link" aria-label="Direct link to dispose" title="Direct link to dispose" translate="no"></a></h3>
|
|
131
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">dispose</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 punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=></span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">void</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
132
|
-
<p>dispose the scripting object</p>
|
|
133
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-6">Returns<a href="#returns-6" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
134
|
-
<p><code>void</code></p>
|
|
135
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="inherited-from-4">Inherited from<a href="#inherited-from-4" class="hash-link" aria-label="Direct link to Inherited from" title="Direct link to Inherited from" translate="no"></a></h4>
|
|
136
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">ScriptingObject</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">dispose</span><br></div></code></pre></div></div>
|
|
137
|
-
<hr>
|
|
138
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="endtiming">endTiming<a href="#endtiming" class="hash-link" aria-label="Direct link to endTiming" title="Direct link to endTiming" translate="no"></a></h3>
|
|
139
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">endTiming</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">start</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token builtin">string</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> PerfMark</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> options</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> TimingOptions</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </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 keyword" style="color:#00009f">void</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
140
|
-
<p>End a performance timing measurement by calling <code>performance.measure()</code>.</p>
|
|
141
|
-
<p>The resulting measure entry is automatically captured by the
|
|
142
|
-
PerformanceObserver pipeline, which filters, samples, and fans out
|
|
143
|
-
to Splunk and GTM. The mark is cleared after measurement.</p>
|
|
144
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="what-each-destination-receives">What each destination receives<a href="#what-each-destination-receives" class="hash-link" aria-label="Direct link to What each destination receives" title="Direct link to What each destination receives" translate="no"></a></h2>
|
|
145
|
-
<table><thead><tr><th>Destination</th><th>Event name</th><th>Payload</th></tr></thead><tbody><tr><td><strong>Splunk</strong></td><td><code>entry.name</code> (the measurement name)</td><td><code>{ message: 'timing', event, duration, startTime, detail }</code></td></tr><tr><td><strong>GTM</strong></td><td><code>timing:<name></code></td><td>BA params + product details + <code>{ duration, startTime, startAppId, startAppUrl, endAppId, endAppUrl }</code></td></tr></tbody></table>
|
|
146
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="accepted-start-formats">Accepted <code>start</code> formats<a href="#accepted-start-formats" class="hash-link" aria-label="Direct link to accepted-start-formats" title="Direct link to accepted-start-formats" translate="no"></a></h2>
|
|
147
|
-
<ul>
|
|
148
|
-
<li class=""><strong><code>PerfMark</code></strong> (return value of <a href="#starttiming" class="">startTiming</a>) — uses <code>startTime</code>
|
|
149
|
-
for sub-millisecond accuracy even if the mark was cleared externally.</li>
|
|
150
|
-
<li class=""><strong><code>string</code></strong> (the name passed to <a href="#starttiming" class="">startTiming</a>) — looks up the mark
|
|
151
|
-
by name; falls back to <code>performance.now()</code> if the mark is missing.</li>
|
|
152
|
-
</ul>
|
|
153
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="parameters-2">Parameters<a href="#parameters-2" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
|
|
154
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="start">start<a href="#start" class="hash-link" aria-label="Direct link to start" title="Direct link to start" translate="no"></a></h5>
|
|
155
|
-
<p><code>string</code> | <code>PerfMark</code></p>
|
|
156
|
-
<p>The PerfMark returned by <code>startTiming</code>, or the name string</p>
|
|
157
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="options">options<a href="#options" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no"></a></h5>
|
|
158
|
-
<p><code>TimingOptions</code></p>
|
|
159
|
-
<p>Must include <code>appId</code> and <code>appUrl</code> for the end context</p>
|
|
160
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-7">Returns<a href="#returns-7" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
161
|
-
<p><code>Promise</code><<code>void</code>></p>
|
|
162
|
-
<p>A pre-resolved promise (for interface compatibility)</p>
|
|
163
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="throws">Throws<a href="#throws" class="hash-link" aria-label="Direct link to Throws" title="Direct link to Throws" translate="no"></a></h4>
|
|
164
|
-
<p>If <code>start</code> is falsy or <code>options.appId</code> / <code>options.appUrl</code> are missing</p>
|
|
165
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="examples">Examples<a href="#examples" class="hash-link" aria-label="Direct link to Examples" title="Direct link to Examples" translate="no"></a></h4>
|
|
166
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Using the PerfMark object (recommended)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> mark </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">startTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'LongTask'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'myApp'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'https://myapp.com'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">doWork</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">endTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">mark</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'myApp'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'https://myapp.com'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
167
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// Using the name string (cross-app timing — start and end may differ)</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">startTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'LongTask'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'appA'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'https://appA.com'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> </span><span class="token function" style="color:#d73a49">doWork</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">endTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'LongTask'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'appB'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'https://appB.com'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
168
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-5">Implementation of<a href="#implementation-of-5" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
169
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">endTiming</span><br></div></code></pre></div></div>
|
|
170
|
-
<hr>
|
|
171
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="getalltimingeventsamplingratios">getAllTimingEventSamplingRatios<a href="#getalltimingeventsamplingratios" class="hash-link" aria-label="Direct link to getAllTimingEventSamplingRatios" title="Direct link to getAllTimingEventSamplingRatios" translate="no"></a></h3>
|
|
172
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">getAllTimingEventSamplingRatios</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 punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=></span><span class="token plain"> Record</span><span class="token operator" style="color:#393A34"><</span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
173
|
-
<p>Return a snapshot of all explicitly configured timing event sampling ratios.</p>
|
|
174
|
-
<p>Events using the default ratio (0.25) are <strong>not</strong> included. The returned
|
|
175
|
-
object is a copy — mutating it does not affect the internal state.</p>
|
|
176
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-8">Returns<a href="#returns-8" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
177
|
-
<p><code>Record</code><<code>string</code>, <code>number</code>></p>
|
|
178
|
-
<p>Map of event name to ratio for all explicitly configured events</p>
|
|
179
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="example-2">Example<a href="#example-2" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
|
180
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> ratios </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">getAllTimingEventSamplingRatios</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// { 'api-call': 0.1, 'user-interaction': 0.5 }</span><br></div></code></pre></div></div>
|
|
181
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-6">Implementation of<a href="#implementation-of-6" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
182
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">getAllTimingEventSamplingRatios</span><br></div></code></pre></div></div>
|
|
183
|
-
<hr>
|
|
184
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="gettimingeventsamplingratio">getTimingEventSamplingRatio<a href="#gettimingeventsamplingratio" class="hash-link" aria-label="Direct link to getTimingEventSamplingRatio" title="Direct link to getTimingEventSamplingRatio" translate="no"></a></h3>
|
|
185
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">getTimingEventSamplingRatio</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">names</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 punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=></span><span class="token plain"> Record</span><span class="token operator" style="color:#393A34"><</span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">|</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">undefined</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
186
|
-
<p>Retrieve the current sampling ratios for the specified timing event names.</p>
|
|
187
|
-
<p>Returns <code>undefined</code> for events that have no explicit ratio configured
|
|
188
|
-
(i.e. they use the default 0.25).</p>
|
|
189
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="parameters-3">Parameters<a href="#parameters-3" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
|
|
190
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="names-1">names<a href="#names-1" class="hash-link" aria-label="Direct link to names" title="Direct link to names" translate="no"></a></h5>
|
|
191
|
-
<p><code>string</code>[]</p>
|
|
192
|
-
<p>Array of event names to query</p>
|
|
193
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-9">Returns<a href="#returns-9" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
194
|
-
<p><code>Record</code><<code>string</code>, <code>number</code> | <code>undefined</code>></p>
|
|
195
|
-
<p>Map of event name to ratio, or <code>undefined</code> if using default</p>
|
|
196
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="example-3">Example<a href="#example-3" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
|
197
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> ratios </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">getTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">[</span><span class="token string" style="color:#e3116c">'api-call'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'page-load'</span><span class="token punctuation" style="color:#393A34">]</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// { 'api-call': 0.1, 'page-load': undefined }</span><br></div></code></pre></div></div>
|
|
198
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-7">Implementation of<a href="#implementation-of-7" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
199
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">getTimingEventSamplingRatio</span><br></div></code></pre></div></div>
|
|
200
|
-
<hr>
|
|
201
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="sendbaevent">sendBAEvent<a href="#sendbaevent" class="hash-link" aria-label="Direct link to sendBAEvent" title="Direct link to sendBAEvent" translate="no"></a></h3>
|
|
202
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">sendBAEvent</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">eve</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> BAEvent</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </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 keyword" style="color:#00009f">void</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
203
|
-
<p>Send a business analytics event to GTM and LogRocket.</p>
|
|
204
|
-
<p><strong>No sampling or head-sampling is applied</strong> — every call reaches both
|
|
205
|
-
destinations (subject to LogRocket's sliding-window throttle).</p>
|
|
206
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="gtm-properties-gtmdatalayerpush">GTM properties (<code>gtmDataLayer.push</code>)<a href="#gtm-properties-gtmdatalayerpush" class="hash-link" aria-label="Direct link to gtm-properties-gtmdatalayerpush" title="Direct link to gtm-properties-gtmdatalayerpush" translate="no"></a></h2>
|
|
207
|
-
<table><thead><tr><th>Property</th><th>Source</th></tr></thead><tbody><tr><td><code>event</code></td><td>Caller-supplied <code>event</code> field</td></tr><tr><td><code>envName</code></td><td><code>sessionStorage.getItem('envName')</code></td></tr><tr><td><code>appId</code></td><td><code>window.emui.appId</code></td></tr><tr><td><code>instanceId</code></td><td><code>sessionStorage.getItem('instanceId')</code></td></tr><tr><td><code>userId</code></td><td><code>sessionStorage.getItem('userId')</code></td></tr><tr><td><code>...appParameters</code></td><td>Fields set via <code>updateBAEventParameters()</code></td></tr><tr><td><code>productId</code></td><td><code>window.parent.emui.appId</code></td></tr><tr><td><code>productPath</code></td><td><code>window.parent.location.pathname</code></td></tr><tr><td><code>productUrl</code></td><td><code>window.parent.location.href</code></td></tr><tr><td><code>productPageTitle</code></td><td><code>window.parent.document.title</code></td></tr><tr><td><code>version</code></td><td><code>window.parent.emui.version</code></td></tr><tr><td><code>appPath</code></td><td><code>window.location.pathname</code></td></tr><tr><td><code>appUrl</code></td><td><code>window.location.href</code></td></tr><tr><td><code>appPageTitle</code></td><td><code>document.title</code></td></tr><tr><td><code>...rest</code></td><td>All other caller-supplied fields</td></tr></tbody></table>
|
|
208
|
-
<h2 class="anchor anchorTargetStickyNavbar_LxAM" id="logrocket-properties-logrockettrack">LogRocket properties (<code>logRocket.track</code>)<a href="#logrocket-properties-logrockettrack" class="hash-link" aria-label="Direct link to logrocket-properties-logrockettrack" title="Direct link to logrocket-properties-logrockettrack" translate="no"></a></h2>
|
|
209
|
-
<table><thead><tr><th>Property</th><th>Source</th></tr></thead><tbody><tr><td>Track event name</td><td>Caller-supplied <code>event</code> field</td></tr><tr><td><code>...rest</code></td><td>All caller-supplied fields <strong>except</strong> <code>event</code></td></tr></tbody></table>
|
|
210
|
-
<p>No ambient context (<code>envName</code>, <code>appId</code>, <code>instanceId</code>, <code>userId</code>, product
|
|
211
|
-
details, <code>appParameters</code>) is sent to LogRocket.</p>
|
|
212
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="parameters-4">Parameters<a href="#parameters-4" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
|
|
213
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="eve">eve<a href="#eve" class="hash-link" aria-label="Direct link to eve" title="Direct link to eve" translate="no"></a></h5>
|
|
214
|
-
<p><code>BAEvent</code></p>
|
|
215
|
-
<p>Business analytics event. Must contain an <code>event</code> string field; all other fields are forwarded as-is. Returns immediately if <code>event</code> is falsy.</p>
|
|
216
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-10">Returns<a href="#returns-10" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
217
|
-
<p><code>Promise</code><<code>void</code>></p>
|
|
218
|
-
<p>A pre-resolved promise (for interface compatibility)</p>
|
|
219
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="example-4">Example<a href="#example-4" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
|
220
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token comment" style="color:#999988;font-style:italic">// User action tracking</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">sendBAEvent</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> event</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'button-click'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> buttonId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'submit'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Page view tracking</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">sendBAEvent</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> event</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'page-view'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> page</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'/dashboard'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Feature usage</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">sendBAEvent</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> event</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'feature-used'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> feature</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'export-pdf'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain" style="display:inline-block"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// Error tracking</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">sendBAEvent</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> event</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'api-error'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> endpoint</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'/users'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> status</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">500</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
221
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-8">Implementation of<a href="#implementation-of-8" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
222
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">sendBAEvent</span><br></div></code></pre></div></div>
|
|
223
|
-
<hr>
|
|
224
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="settimingeventsamplingratio">setTimingEventSamplingRatio<a href="#settimingeventsamplingratio" class="hash-link" aria-label="Direct link to setTimingEventSamplingRatio" title="Direct link to setTimingEventSamplingRatio" translate="no"></a></h3>
|
|
225
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">setTimingEventSamplingRatio</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">ratios</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> Record</span><span class="token operator" style="color:#393A34"><</span><span class="token builtin">string</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token builtin">number</span><span class="token operator" style="color:#393A34">></span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </span><span class="token operator" style="color:#393A34">=></span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">void</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
226
|
-
<p>Set or update sampling ratios for one or more timing event names.</p>
|
|
227
|
-
<p>Sampling applies <strong>uniformly to both timing destinations</strong> (Splunk and
|
|
228
|
-
GTM) — there is no per-destination sampling. Events not configured here
|
|
229
|
-
fall back to the default ratio of 0.25 (25%).</p>
|
|
230
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="parameters-5">Parameters<a href="#parameters-5" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
|
|
231
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="ratios">ratios<a href="#ratios" class="hash-link" aria-label="Direct link to ratios" title="Direct link to ratios" translate="no"></a></h5>
|
|
232
|
-
<p><code>Record</code><<code>string</code>, <code>number</code>></p>
|
|
233
|
-
<p>Map of event name to ratio (0 = never, 1 = always)</p>
|
|
234
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-11">Returns<a href="#returns-11" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
235
|
-
<p><code>void</code></p>
|
|
236
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="example-5">Example<a href="#example-5" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
|
237
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">setTimingEventSamplingRatio</span><span class="token punctuation" style="color:#393A34">(</span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string-property property" style="color:#36acaa">'api-call'</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.1</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// 10% — high-frequency, keep volume low</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string-property property" style="color:#36acaa">'page-load'</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">1.0</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// 100% — critical, capture every instance</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token string-property property" style="color:#36acaa">'user-interaction'</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token number" style="color:#36acaa">0.5</span><span class="token plain"> </span><span class="token comment" style="color:#999988;font-style:italic">// 50%</span><span class="token plain"></span><br></div><div 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 punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
238
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-9">Implementation of<a href="#implementation-of-9" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
239
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">setTimingEventSamplingRatio</span><br></div></code></pre></div></div>
|
|
240
|
-
<hr>
|
|
241
|
-
<h3 class="anchor anchorTargetStickyNavbar_LxAM" id="starttiming">startTiming<a href="#starttiming" class="hash-link" aria-label="Direct link to startTiming" title="Direct link to startTiming" translate="no"></a></h3>
|
|
242
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token function-variable function" style="color:#d73a49">startTiming</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">name</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"> options</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> TimingOptions</span><span class="token punctuation" style="color:#393A34">)</span><span class="token plain"> </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></div><div class="token-line" style="color:#393A34"><span class="token plain"> name</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></div><div class="token-line" style="color:#393A34"><span class="token plain"> startTime</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></div><div 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></div></code></pre></div></div>
|
|
243
|
-
<p>Start a performance timing measurement by creating a <code>performance.mark()</code>.</p>
|
|
244
|
-
<p>The returned PerfMark (or the <code>name</code> string) is later passed to
|
|
245
|
-
<a href="#endtiming" class="">endTiming</a> which calls <code>performance.measure()</code>. That measure is
|
|
246
|
-
automatically picked up by the PerformanceObserver pipeline, which
|
|
247
|
-
samples and fans out to Splunk and GTM.</p>
|
|
248
|
-
<p>If a mark with the same <code>name</code> already exists it will be replaced by the
|
|
249
|
-
browser's Performance API.</p>
|
|
250
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="parameters-6">Parameters<a href="#parameters-6" class="hash-link" aria-label="Direct link to Parameters" title="Direct link to Parameters" translate="no"></a></h4>
|
|
251
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="name">name<a href="#name" class="hash-link" aria-label="Direct link to name" title="Direct link to name" translate="no"></a></h5>
|
|
252
|
-
<p><code>string</code></p>
|
|
253
|
-
<p>Unique name for the measurement (e.g. <code>'api-call'</code>, <code>'page-load'</code>)</p>
|
|
254
|
-
<h5 class="anchor anchorTargetStickyNavbar_LxAM" id="options-1">options<a href="#options-1" class="hash-link" aria-label="Direct link to options" title="Direct link to options" translate="no"></a></h5>
|
|
255
|
-
<p><code>TimingOptions</code></p>
|
|
256
|
-
<p>Must include <code>appId</code> and <code>appUrl</code>; stored as <code>detail</code> on the mark</p>
|
|
257
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="returns-12">Returns<a href="#returns-12" class="hash-link" aria-label="Direct link to Returns" title="Direct link to Returns" translate="no"></a></h4>
|
|
258
|
-
<p><code>Promise</code><{
|
|
259
|
-
<code>name</code>: <code>string</code>;
|
|
260
|
-
<code>startTime</code>: <code>number</code>;
|
|
261
|
-
}></p>
|
|
262
|
-
<p>A promise resolving to <code>{ name, startTime }</code> for passing to <a href="#endtiming" class="">endTiming</a></p>
|
|
263
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="throws-1">Throws<a href="#throws-1" class="hash-link" aria-label="Direct link to Throws" title="Direct link to Throws" translate="no"></a></h4>
|
|
264
|
-
<p>If <code>name</code> is falsy or <code>options.appId</code> / <code>options.appUrl</code> are missing</p>
|
|
265
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="example-6">Example<a href="#example-6" class="hash-link" aria-label="Direct link to Example" title="Direct link to Example" translate="no"></a></h4>
|
|
266
|
-
<div class="language-typescript codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-typescript codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token keyword" style="color:#00009f">const</span><span class="token plain"> mark </span><span class="token operator" style="color:#393A34">=</span><span class="token plain"> </span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">startTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token string" style="color:#e3116c">'api-call'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'loan-service'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'https://app.example.com/loans'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"></span><br></div><div 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 punctuation" style="color:#393A34">;</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token comment" style="color:#999988;font-style:italic">// ... perform work ...</span><span class="token plain"></span><br></div><div class="token-line" style="color:#393A34"><span class="token plain"></span><span class="token keyword" style="color:#00009f">await</span><span class="token plain"> analytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token function" style="color:#d73a49">endTiming</span><span class="token punctuation" style="color:#393A34">(</span><span class="token plain">mark</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">{</span><span class="token plain"> appId</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'loan-service'</span><span class="token punctuation" style="color:#393A34">,</span><span class="token plain"> appUrl</span><span class="token operator" style="color:#393A34">:</span><span class="token plain"> </span><span class="token string" style="color:#e3116c">'https://app.example.com/loans'</span><span class="token plain"> </span><span class="token punctuation" style="color:#393A34">}</span><span class="token punctuation" style="color:#393A34">)</span><span class="token punctuation" style="color:#393A34">;</span><br></div></code></pre></div></div>
|
|
267
|
-
<h4 class="anchor anchorTargetStickyNavbar_LxAM" id="implementation-of-10">Implementation of<a href="#implementation-of-10" class="hash-link" aria-label="Direct link to Implementation of" title="Direct link to Implementation of" translate="no"></a></h4>
|
|
268
|
-
<div class="language-ts codeBlockContainer_EUFB theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_UdBd"><pre tabindex="0" class="prism-code language-ts codeBlock_RL5w thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_V7PD"><div class="token-line" style="color:#393A34"><span class="token plain">IAnalytics</span><span class="token punctuation" style="color:#393A34">.</span><span class="token plain">startTiming</span><br></div></code></pre></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_CXW_"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git/docs/api/classes/Analytics.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_lW2Z" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_jQ0h"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/app-sdk/api/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">App SDK API</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/app-sdk/api/classes/CMicroAppGuest"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">CMicroAppGuest\<AppObjects, AppEvents\></div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_HU9B thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#destinations" class="table-of-contents__link toc-highlight">Destinations</a></li><li><a href="#use-cases" class="table-of-contents__link toc-highlight">Use cases</a><ul><li><a href="#1-business-analytics-events-sendbaevent" class="table-of-contents__link toc-highlight">1. Business analytics events (<code>sendBAEvent</code>)</a></li><li><a href="#2-manual-performance-timing-starttiming--endtiming" class="table-of-contents__link toc-highlight">2. Manual performance timing (<code>startTiming</code> / <code>endTiming</code>)</a></li><li><a href="#3-automatic-performance-observation-monitorperformance" class="table-of-contents__link toc-highlight">3. Automatic performance observation (<code>#monitorPerformance</code>)</a></li><li><a href="#4-sampling-ratio-management" class="table-of-contents__link toc-highlight">4. Sampling ratio management</a></li></ul></li><li><a href="#example" class="table-of-contents__link toc-highlight">Example</a></li><li><a href="#extends" class="table-of-contents__link toc-highlight">Extends</a></li><li><a href="#implements" class="table-of-contents__link toc-highlight">Implements</a></li><li><a href="#accessors" class="table-of-contents__link toc-highlight">Accessors</a><ul><li><a href="#id" class="table-of-contents__link toc-highlight">id</a></li><li><a href="#objecttype" class="table-of-contents__link toc-highlight">objectType</a></li></ul></li><li><a href="#constructors" class="table-of-contents__link toc-highlight">Constructors</a><ul><li><a href="#constructor" class="table-of-contents__link toc-highlight">Constructor</a></li></ul></li><li><a href="#properties" class="table-of-contents__link toc-highlight">Properties</a><ul><li><a href="#_dispose" class="table-of-contents__link toc-highlight">_dispose</a></li><li><a href="#_tojson" class="table-of-contents__link toc-highlight">_toJSON</a></li><li><a href="#deletetimingeventsamplingratio" class="table-of-contents__link toc-highlight">deleteTimingEventSamplingRatio</a></li><li><a href="#dispose" class="table-of-contents__link toc-highlight">dispose</a></li><li><a href="#endtiming" class="table-of-contents__link toc-highlight">endTiming</a></li></ul></li><li><a href="#what-each-destination-receives" class="table-of-contents__link toc-highlight">What each destination receives</a></li><li><a href="#accepted-start-formats" class="table-of-contents__link toc-highlight">Accepted <code>start</code> formats</a><ul><li><a href="#getalltimingeventsamplingratios" class="table-of-contents__link toc-highlight">getAllTimingEventSamplingRatios</a></li><li><a href="#gettimingeventsamplingratio" class="table-of-contents__link toc-highlight">getTimingEventSamplingRatio</a></li><li><a href="#sendbaevent" class="table-of-contents__link toc-highlight">sendBAEvent</a></li></ul></li><li><a href="#gtm-properties-gtmdatalayerpush" class="table-of-contents__link toc-highlight">GTM properties (<code>gtmDataLayer.push</code>)</a></li><li><a href="#logrocket-properties-logrockettrack" class="table-of-contents__link toc-highlight">LogRocket properties (<code>logRocket.track</code>)</a><ul><li><a href="#settimingeventsamplingratio" class="table-of-contents__link toc-highlight">setTimingEventSamplingRatio</a></li><li><a href="#starttiming" class="table-of-contents__link toc-highlight">startTiming</a></li></ul></li></ul></div></div></div></div></main></div></div></div><footer class="theme-layout-footer footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/app-sdk/">Getting Started</a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://icemortgagetechnology.slack.com/archives/C01M49EGP6Z" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_uxYp"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div><div class="theme-layout-footer-column col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://git.elliemae.io/platform-ui/pui-app-sdk.git" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_uxYp"><use href="#theme-svg-external-link"></use></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2026 ICE.</div></div></div></footer></div>
|
|
269
|
-
</body>
|
|
270
|
-
</html>
|