@qlik/api 1.42.0 → 1.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-keys.d.ts +2 -2
- package/api-keys.js +3 -3
- package/apps.d.ts +2 -2
- package/apps.js +3 -3
- package/assistants.d.ts +2 -2
- package/assistants.js +3 -3
- package/audits.d.ts +3 -3
- package/audits.js +17 -4
- package/auth-types.d.ts +1 -1
- package/auth.d.ts +2 -2
- package/auth.js +2 -2
- package/automation-connections.d.ts +2 -2
- package/automation-connections.js +3 -3
- package/automations.d.ts +3 -3
- package/automations.js +3 -3
- package/automl-deployments.d.ts +2 -2
- package/automl-deployments.js +5 -3
- package/automl-predictions.d.ts +2 -2
- package/automl-predictions.js +15 -3
- package/brands.d.ts +2 -2
- package/brands.js +3 -3
- package/chunks/{api-keys-CI44OuNR.d.ts → api-keys-C-ZqA-wl.d.ts} +1 -1
- package/chunks/{apps-BiGof9WJ.d.ts → apps-CJH5JjKB.d.ts} +1 -1
- package/chunks/{assistants-CDtI99Yr.d.ts → assistants-BsDbpzl4.d.ts} +7 -1
- package/chunks/{audits-C-UDFprK.d.ts → audits-5CBpwcdx.d.ts} +24 -2
- package/chunks/{auth-Cl-o3AnG.js → auth-CCj082fh.js} +3 -3
- package/chunks/{auth-B5Hx9GeQ.d.ts → auth-DFOXWfqh.d.ts} +3 -3
- package/chunks/{auth-DD2ENDUe.js → auth-IDN6Z4Nr.js} +2 -2
- package/chunks/{auth-functions-DHRxWU6t.js → auth-functions-CZbgZARw.js} +72 -24
- package/chunks/{auth-types-BlCWK0FP.d.ts → auth-types-B1c_1Nca.d.ts} +4 -1
- package/chunks/{automation-connections-keN9CuNO.d.ts → automation-connections-DRQDgw7Q.d.ts} +1 -1
- package/chunks/{automations-CFRnQ8sX.d.ts → automations-arVbySrW.d.ts} +13 -4
- package/chunks/{automl-deployments-D05clUGa.d.ts → automl-deployments-B-WuR_zE.d.ts} +5 -1
- package/chunks/{automl-predictions-Ddp6PdpE.d.ts → automl-predictions-CewW0eZn.d.ts} +25 -1
- package/chunks/{brands-hEcnkdfg.d.ts → brands-C4eALPrs.d.ts} +1 -1
- package/chunks/{collections-CuX8Cp8Z.d.ts → collections-Djmd9gof.d.ts} +1 -1
- package/chunks/{conditions-DUmPB4Ej.d.ts → conditions-BRDxUbgu.d.ts} +1 -1
- package/chunks/{consumption-CSptDhk9.d.ts → consumption-UNw8R7jN.d.ts} +1 -1
- package/chunks/{csp-origins-v_UyOSK9.d.ts → csp-origins-_4HBSdgU.d.ts} +1 -1
- package/chunks/{csrf-token-DZK6GX6Z.d.ts → csrf-token-CsvbqXyY.d.ts} +1 -1
- package/chunks/{data-alerts-DwPcCvHP.d.ts → data-alerts-DSV3VOnW.d.ts} +1 -1
- package/chunks/{data-assets-BPMOGSO7.d.ts → data-assets-C3U3T_lj.d.ts} +1 -1
- package/chunks/{data-connections-DK1AhSi4.d.ts → data-connections-BYNfX1Fl.d.ts} +1 -1
- package/chunks/{data-credentials-BDCHbRwM.d.ts → data-credentials-CgCjw_Cn.d.ts} +1 -1
- package/chunks/{data-files-D7mlQnrw.d.ts → data-files-DH19MfYE.d.ts} +1 -1
- package/chunks/{data-qualities-Z554f_p6.d.ts → data-qualities-BogHQw4I.d.ts} +1 -1
- package/chunks/{data-sets-AcCLu1zw.d.ts → data-sets-B27GmshO.d.ts} +1 -1
- package/chunks/{data-sources-hfHV7WaV.d.ts → data-sources-D_TRdWV-.d.ts} +1 -1
- package/chunks/{data-stores-Bofu7fl5.d.ts → data-stores-BjfzMp9W.d.ts} +1 -1
- package/chunks/{dcaas-DK4f7Rrs.d.ts → dcaas-A7hfpAI5.d.ts} +1 -1
- package/chunks/{di-projects-DYJgDVfh.d.ts → di-projects-mdshgyFv.d.ts} +69 -13
- package/chunks/{direct-access-agents-Pmhjq2z5.d.ts → direct-access-agents-CfUpbi73.d.ts} +1 -1
- package/chunks/{dist-CjqdvDf3.js → dist-UZqmL_Q6.js} +15 -10
- package/chunks/{encryption-CMJWtMcm.d.ts → encryption-CjBmNQDZ.d.ts} +1 -1
- package/chunks/{extensions-Ct2JAsbk.d.ts → extensions-D05y2FWk.d.ts} +1 -1
- package/chunks/{glossaries-Drx-EwiU.d.ts → glossaries-vYbykU3r.d.ts} +1 -1
- package/chunks/{groups-C-R5oUEa.d.ts → groups-BapgngJf.d.ts} +1 -1
- package/chunks/{identity-providers-Bj88evsO.d.ts → identity-providers-CAxsp9hP.d.ts} +1 -1
- package/chunks/{interceptors-e6hoYE8W.d.ts → interceptors-BF556LaK.d.ts} +1 -1
- package/chunks/{interceptors-DD0vKL8_.js → interceptors-DBoV6UkN.js} +1 -1
- package/chunks/{invoke-fetch-DbVuX5mE.js → invoke-fetch-09EW5w1d.js} +3 -3
- package/chunks/{invoke-fetch-BIh4VnG4.js → invoke-fetch-fXOUPARi.js} +3 -3
- package/chunks/{items-BnN6gI0J.d.ts → items-CjVrNg57.d.ts} +1 -1
- package/chunks/{knowledgebases-tmPZVD6i.d.ts → knowledgebases-BFiV7Fwh.d.ts} +1 -1
- package/chunks/{licenses-DAPVQuFJ.d.ts → licenses-yZKgQ2k6.d.ts} +1 -1
- package/chunks/{lineage-graphs-Q4LiGGtL.d.ts → lineage-graphs-Bkc04N-t.d.ts} +1 -1
- package/chunks/{ml-C80TkK1J.d.ts → ml-CABYvU_L.d.ts} +8 -14
- package/chunks/{notes-CHvadRai.d.ts → notes-C5HjmBeI.d.ts} +1 -1
- package/chunks/{notifications-BhS8s4Eo.d.ts → notifications-DfP7aWPH.d.ts} +1 -1
- package/chunks/{oauth-clients-D1f8xiFC.d.ts → oauth-clients-BmMEDuET.d.ts} +1 -1
- package/chunks/{oauth-tokens-DteoDifd.d.ts → oauth-tokens-Dimf19DE.d.ts} +1 -1
- package/chunks/{public-runtime-modules-CNGnt1rU.js → public-runtime-modules-P9LEbn8i.js} +3 -3
- package/chunks/{qix-T3MHM_Lb.d.ts → qix-C1WaB-67.d.ts} +2 -2
- package/chunks/{qix-3nXOY2qw.js → qix-C86sBDw3.js} +1 -1
- package/chunks/{qix-DbtKisCn.js → qix-Ds6X5svJ.js} +5 -5
- package/chunks/{qix-chunk-entrypoint-xeI9UjuJ.js → qix-chunk-entrypoint-CpkRq84_.js} +426 -89
- package/chunks/{questions-BiR5-mZ4.d.ts → questions-CFN7BgWt.d.ts} +1 -1
- package/chunks/{quotas-GTQL9uPt.d.ts → quotas-BUH2e2K_.d.ts} +1 -1
- package/chunks/{reload-tasks-CmXJp5va.d.ts → reload-tasks-DN3X2-30.d.ts} +1 -1
- package/chunks/{reloads-3XgvVnbq.d.ts → reloads-ClLQO7Vt.d.ts} +1 -1
- package/chunks/{report-templates-BowaTti4.d.ts → report-templates-D5KOFkRi.d.ts} +1 -1
- package/chunks/{reports-D-sRL947.d.ts → reports-CRwCogRL.d.ts} +85 -2
- package/chunks/{roles-D93ENaRt.d.ts → roles-DCzyiLdU.d.ts} +1 -1
- package/chunks/{sharing-tasks-BMDAjWTj.d.ts → sharing-tasks-DsxFrADQ.d.ts} +1 -1
- package/chunks/{spaces-DFQCYg41.d.ts → spaces-B0cx23Nc.d.ts} +1 -1
- package/chunks/{tasks-BWmS6L8Y.d.ts → tasks-DWfE5JM_.d.ts} +1 -1
- package/chunks/{temp-contents-CZVb5P0V.d.ts → temp-contents-CU94UTZU.d.ts} +1 -1
- package/chunks/{tenants-BDH4DmcO.d.ts → tenants-DvtbiwAP.d.ts} +1 -1
- package/chunks/{themes-BkubWfOE.d.ts → themes-BPkyCLWS.d.ts} +1 -1
- package/chunks/{transports-CO9kRJg5.d.ts → transports-DlRmSWLj.d.ts} +1 -1
- package/chunks/{ui-config-DIOnLEV9.d.ts → ui-config-BqX-bPjf.d.ts} +1 -1
- package/chunks/{users-DM-ZfzQB.d.ts → users-CuQ0nboa.d.ts} +1 -1
- package/chunks/{utils-qEQ6sEXX.js → utils-CAGXTaqJ.js} +14 -1
- package/chunks/{web-integrations-BjVMC88M.d.ts → web-integrations-D54LCd0Z.d.ts} +1 -1
- package/chunks/{web-notifications-D-eA8h1I.d.ts → web-notifications-sUlHGnmy.d.ts} +1 -1
- package/chunks/{webhooks-Dytyr5nk.d.ts → webhooks-Dw0FIeFq.d.ts} +1 -1
- package/collections.d.ts +2 -2
- package/collections.js +3 -3
- package/conditions.d.ts +2 -2
- package/conditions.js +3 -3
- package/consumption.d.ts +2 -2
- package/consumption.js +3 -3
- package/csp-origins.d.ts +2 -2
- package/csp-origins.js +3 -3
- package/csrf-token.d.ts +2 -2
- package/csrf-token.js +3 -3
- package/data-alerts.d.ts +2 -2
- package/data-alerts.js +3 -3
- package/data-assets.d.ts +2 -2
- package/data-assets.js +3 -3
- package/data-connections.d.ts +2 -2
- package/data-connections.js +3 -3
- package/data-credentials.d.ts +2 -2
- package/data-credentials.js +3 -3
- package/data-files.d.ts +2 -2
- package/data-files.js +3 -3
- package/data-qualities.d.ts +2 -2
- package/data-qualities.js +3 -3
- package/data-sets.d.ts +2 -2
- package/data-sets.js +3 -3
- package/data-sources.d.ts +2 -2
- package/data-sources.js +3 -3
- package/data-stores.d.ts +2 -2
- package/data-stores.js +3 -3
- package/dcaas.d.ts +2 -2
- package/dcaas.js +3 -3
- package/di-projects.d.ts +3 -3
- package/di-projects.js +4 -4
- package/direct-access-agents.d.ts +2 -2
- package/direct-access-agents.js +3 -3
- package/docs/authentication.md +65 -1
- package/docs/rest.md +1 -1
- package/encryption.d.ts +2 -2
- package/encryption.js +3 -3
- package/extensions.d.ts +2 -2
- package/extensions.js +3 -3
- package/global-types.d.ts +1 -1
- package/glossaries.d.ts +2 -2
- package/glossaries.js +3 -3
- package/groups.d.ts +2 -2
- package/groups.js +3 -3
- package/identity-providers.d.ts +2 -2
- package/identity-providers.js +3 -3
- package/index.d.ts +63 -63
- package/index.js +73 -69
- package/interceptors.d.ts +2 -2
- package/interceptors.js +2 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +2 -2
- package/items.js +3 -3
- package/knowledgebases.d.ts +2 -2
- package/knowledgebases.js +3 -3
- package/licenses.d.ts +2 -2
- package/licenses.js +3 -3
- package/lineage-graphs.d.ts +2 -2
- package/lineage-graphs.js +3 -3
- package/ml.d.ts +3 -3
- package/ml.js +4 -4
- package/notes.d.ts +2 -2
- package/notes.js +3 -3
- package/notifications.d.ts +2 -2
- package/notifications.js +3 -3
- package/oauth-clients.d.ts +2 -2
- package/oauth-clients.js +3 -3
- package/oauth-tokens.d.ts +2 -2
- package/oauth-tokens.js +3 -3
- package/package.json +2 -2
- package/qix.d.ts +3 -3
- package/qix.js +2 -2
- package/questions.d.ts +2 -2
- package/questions.js +3 -3
- package/quotas.d.ts +2 -2
- package/quotas.js +3 -3
- package/reload-tasks.d.ts +2 -2
- package/reload-tasks.js +3 -3
- package/reloads.d.ts +2 -2
- package/reloads.js +3 -3
- package/report-templates.d.ts +2 -2
- package/report-templates.js +3 -3
- package/reports.d.ts +3 -3
- package/reports.js +22 -4
- package/roles.d.ts +2 -2
- package/roles.js +3 -3
- package/sharing-tasks.d.ts +2 -2
- package/sharing-tasks.js +3 -3
- package/spaces.d.ts +2 -2
- package/spaces.js +3 -3
- package/tasks.d.ts +2 -2
- package/tasks.js +3 -3
- package/temp-contents.d.ts +2 -2
- package/temp-contents.js +3 -3
- package/tenants.d.ts +2 -2
- package/tenants.js +3 -3
- package/themes.d.ts +2 -2
- package/themes.js +3 -3
- package/transports.d.ts +2 -2
- package/transports.js +3 -3
- package/ui-config.d.ts +2 -2
- package/ui-config.js +3 -3
- package/users.d.ts +2 -2
- package/users.js +3 -3
- package/web-integrations.d.ts +2 -2
- package/web-integrations.js +3 -3
- package/web-notifications.d.ts +2 -2
- package/web-notifications.js +3 -3
- package/webhooks.d.ts +2 -2
- package/webhooks.js +3 -3
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/audits.fetchConsumptionAppAudits.html +3 -0
- package/website/functions/auth.setDefaultHostConfig.html +1 -1
- package/website/functions/automations.getAutomationsUsageMetrics.html +5 -1
- package/website/functions/automations.updateAutomation.html +2 -2
- package/website/functions/automl-deployments.createAutomlDeploymentRealtimePrediction.html +3 -3
- package/website/functions/automl-predictions.createAutomlPredictionJob.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionCoordinateShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionNotPredictedReasons.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionPredictions.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionSource.html +3 -3
- package/website/functions/di-projects.getDiProjectDiTaskRuntimeState.html +1 -1
- package/website/functions/ml.getMlDeploymentAliases.html +2 -1
- package/website/functions/reports.getReportOutputs.html +13 -0
- package/website/interfaces/api-keys.ApiKeysAPI.html +8 -8
- package/website/interfaces/apps.AppsAPI.html +45 -45
- package/website/interfaces/assistants.AssistantsAPI.html +29 -29
- package/website/interfaces/audits.AuditsAPI.html +27 -22
- package/website/interfaces/auth.AuthAPI.html +7 -7
- package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +9 -9
- package/website/interfaces/automations.AutomationsAPI.html +29 -25
- package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +7 -7
- package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +37 -37
- package/website/interfaces/brands.BrandsAPI.html +13 -13
- package/website/interfaces/collections.CollectionsAPI.html +12 -12
- package/website/interfaces/conditions.ConditionsAPI.html +12 -12
- package/website/interfaces/consumption.ConsumptionAPI.html +2 -2
- package/website/interfaces/csp-origins.CspOriginsAPI.html +7 -7
- package/website/interfaces/csrf-token.CsrfTokenAPI.html +2 -2
- package/website/interfaces/data-alerts.DataAlertsAPI.html +17 -17
- package/website/interfaces/data-assets.DataAssetsAPI.html +6 -6
- package/website/interfaces/data-connections.DataConnectionsAPI.html +10 -10
- package/website/interfaces/data-credentials.DataCredentialsAPI.html +6 -6
- package/website/interfaces/data-files.DataFilesAPI.html +13 -13
- package/website/interfaces/data-qualities.DataQualitiesAPI.html +4 -4
- package/website/interfaces/data-sets.DataSetsAPI.html +7 -7
- package/website/interfaces/data-sources.DataSourcesAPI.html +4 -4
- package/website/interfaces/data-stores.DataStoresAPI.html +11 -11
- package/website/interfaces/dcaas.DcaasAPI.html +4 -4
- package/website/interfaces/di-projects.DiProjectsAPI.html +18 -18
- package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +13 -13
- package/website/interfaces/encryption.EncryptionAPI.html +11 -11
- package/website/interfaces/extensions.ExtensionsAPI.html +8 -8
- package/website/interfaces/glossaries.GlossariesAPI.html +25 -25
- package/website/interfaces/groups.GroupsAPI.html +9 -9
- package/website/interfaces/identity-providers.IdentityProvidersAPI.html +9 -9
- package/website/interfaces/interceptors.InterceptorsAPI.html +3 -3
- package/website/interfaces/items.ItemsAPI.html +9 -9
- package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +18 -18
- package/website/interfaces/licenses.LicensesAPI.html +10 -10
- package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +9 -9
- package/website/interfaces/ml.MlAPI.html +48 -46
- package/website/interfaces/notes.NotesAPI.html +3 -3
- package/website/interfaces/notifications.NotificationsAPI.html +2 -2
- package/website/interfaces/oauth-clients.OauthClientsAPI.html +12 -12
- package/website/interfaces/oauth-tokens.OauthTokensAPI.html +3 -3
- package/website/interfaces/qix.GenericObject.html +1 -1
- package/website/interfaces/questions.QuestionsAPI.html +3 -3
- package/website/interfaces/quotas.QuotasAPI.html +3 -3
- package/website/interfaces/reload-tasks.ReloadTasksAPI.html +6 -6
- package/website/interfaces/reloads.ReloadsAPI.html +5 -5
- package/website/interfaces/report-templates.ReportTemplatesAPI.html +8 -8
- package/website/interfaces/reports.ReportsAPI.html +26 -8
- package/website/interfaces/roles.RolesAPI.html +6 -6
- package/website/interfaces/sharing-tasks.SharingTasksAPI.html +14 -14
- package/website/interfaces/spaces.SpacesAPI.html +18 -18
- package/website/interfaces/tasks.TasksAPI.html +11 -11
- package/website/interfaces/temp-contents.TempContentsAPI.html +4 -4
- package/website/interfaces/tenants.TenantsAPI.html +7 -7
- package/website/interfaces/themes.ThemesAPI.html +8 -8
- package/website/interfaces/transports.TransportsAPI.html +7 -7
- package/website/interfaces/ui-config.UiConfigAPI.html +8 -8
- package/website/interfaces/users.UsersAPI.html +10 -10
- package/website/interfaces/web-integrations.WebIntegrationsAPI.html +6 -6
- package/website/interfaces/web-notifications.WebNotificationsAPI.html +7 -7
- package/website/interfaces/webhooks.WebhooksAPI.html +11 -11
- package/website/modules/audits.html +1 -1
- package/website/modules/automations.html +1 -1
- package/website/modules/automl-deployments.html +1 -1
- package/website/modules/automl-predictions.html +1 -1
- package/website/modules/di-projects.html +1 -1
- package/website/modules/ml.html +1 -1
- package/website/modules/reports.html +1 -1
- package/website/types/api-keys.Error.html +1 -1
- package/website/types/apps.Error.html +1 -1
- package/website/types/apps.Evaluation.html +1 -1
- package/website/types/apps.RecommendItems.html +1 -1
- package/website/types/apps.RecommendedAnalysis.html +1 -1
- package/website/types/assistants.Assistant.html +4 -2
- package/website/types/assistants.CreateAssistant.html +4 -2
- package/website/types/assistants.CreateAssistantWithAvatar.html +4 -2
- package/website/types/assistants.PromptInput.html +1 -1
- package/website/types/audits.EventExtensions.html +1 -1
- package/website/types/audits.FetchConsumptionAppAuditsHttpError.html +4 -0
- package/website/types/audits.FetchConsumptionAppAuditsHttpResponse.html +4 -0
- package/website/types/audits.GetSettingsResult.html +1 -1
- package/website/types/automations.AutomationDetailUpdateRequestObject.html +6 -0
- package/website/types/automations.CopyAutomationHttpResponse.html +1 -1
- package/website/types/automations.RunDetailResponseObject.html +1 -1
- package/website/types/automl-deployments.Error.html +1 -1
- package/website/types/automl-predictions.Error.html +1 -1
- package/website/types/collections.CollectionByIdPatch.html +1 -1
- package/website/types/csp-origins.CSPEntry.html +1 -1
- package/website/types/data-alerts.AlertingExecutionListResponse.html +1 -1
- package/website/types/data-alerts.AlertingTaskListResponse.html +1 -1
- package/website/types/data-connections.ActionDeleteRequest.html +1 -1
- package/website/types/data-connections.ActionUpdateRequest.html +1 -1
- package/website/types/data-connections.BulkResponse.html +1 -1
- package/website/types/data-connections.Link.html +1 -1
- package/website/types/data-connections.PatchRequest.html +1 -1
- package/website/types/data-connections.TopLevelLink.html +3 -3
- package/website/types/data-credentials.Link.html +1 -1
- package/website/types/data-credentials.PatchRequest.html +1 -1
- package/website/types/data-qualities.DataQualityComputationRequest.html +1 -1
- package/website/types/data-sources.GetDataSourceGatewaysHttpResponse.html +1 -1
- package/website/types/data-sources.QriDefinition.html +2 -2
- package/website/types/di-projects.AsyncActionDetails.html +1 -1
- package/website/types/di-projects.DataTaskInstanceState.html +30 -0
- package/website/types/di-projects.DataTaskRuntimeState.html +6 -0
- package/website/types/di-projects.GetDiProjectDiTaskRuntimeStateHttpResponse.html +2 -2
- package/website/types/encryption.KeyProvider.html +1 -1
- package/website/types/global-types.PerformInteractiveLoginFn.html +1 -1
- package/website/types/groups.AssignedRoles.html +1 -1
- package/website/types/groups.AssignedRolesRefIDs.html +1 -1
- package/website/types/groups.AssignedRolesRefNames.html +1 -1
- package/website/types/groups.Error.html +1 -1
- package/website/types/identity-providers.CreateJWTAuthPayload.html +1 -1
- package/website/types/identity-providers.CreateOIDCPayload.html +2 -2
- package/website/types/identity-providers.CreateSAMLPayload.html +2 -2
- package/website/types/identity-providers.Error.html +1 -1
- package/website/types/identity-providers.IDPOIDC.html +1 -1
- package/website/types/identity-providers.IDPSAML.html +1 -1
- package/website/types/identity-providers.IDPsStatus.html +1 -1
- package/website/types/identity-providers.Links.html +3 -3
- package/website/types/identity-providers.PendingResult.html +1 -1
- package/website/types/interceptors.RestInterceptor.html +1 -1
- package/website/types/invoke-fetch-types.DownloadableBlob.html +1 -1
- package/website/types/items.ItemsSettingsPatch.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateResponse.html +1 -1
- package/website/types/licenses.AssignmentsResponse.html +1 -1
- package/website/types/licenses.ConsumptionEventsResponse.html +1 -1
- package/website/types/licenses.ErrorResponse.html +1 -1
- package/website/types/licenses.LicenseOverview.html +2 -2
- package/website/types/lineage-graphs.ErrorResponse500.html +1 -1
- package/website/types/lineage-graphs.Graph.html +1 -1
- package/website/types/lineage-graphs.Node.html +1 -1
- package/website/types/ml.APIError.html +1 -1
- package/website/types/ml.AliasFindResponse.html +1 -1
- package/website/types/ml.AliasGetResponse.html +1 -1
- package/website/types/ml.AliasPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionActionResponse.html +1 -1
- package/website/types/ml.BatchPredictionFindResponse.html +1 -1
- package/website/types/ml.BatchPredictionGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionPatch.html +1 -1
- package/website/types/ml.BatchPredictionPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleInput.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePatch.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePutResponse.html +1 -1
- package/website/types/ml.DeploymentFindResponse.html +1 -1
- package/website/types/ml.DeploymentGetResponse.html +1 -1
- package/website/types/ml.DeploymentPatch.html +1 -1
- package/website/types/ml.DeploymentPostResponse.html +1 -1
- package/website/types/ml.ExperimentFindResponse.html +1 -1
- package/website/types/ml.ExperimentGetResponse.html +1 -1
- package/website/types/ml.ExperimentInput.html +1 -1
- package/website/types/ml.ExperimentModelRecommendationPostResponse.html +1 -1
- package/website/types/ml.ExperimentPostResponse.html +1 -1
- package/website/types/ml.ExperimentType.html +1 -1
- package/website/types/ml.ExperimentVersionFindResponse.html +1 -1
- package/website/types/ml.ExperimentVersionGetResponse.html +1 -1
- package/website/types/ml.ExperimentVersionPatch.html +1 -1
- package/website/types/ml.ExperimentVersionPostResponse.html +1 -1
- package/website/types/ml.Insights.html +1 -1
- package/website/types/ml.ModelAlgorithm.html +1 -1
- package/website/types/ml.ModelAlgorithmAbbreviation.html +1 -1
- package/website/types/ml.ModelFindResponse.html +1 -1
- package/website/types/ml.ModelGetResponse.html +1 -1
- package/website/types/ml.Pipeline.html +2 -3
- package/website/types/ml.ProfileInsights.html +1 -1
- package/website/types/ml.ProfileInsightsGetResponse.html +1 -1
- package/website/types/ml.ProfileInsightsInput.html +1 -1
- package/website/types/ml.ResponseLinks.html +5 -5
- package/website/types/notifications.NotificationItem.html +1 -1
- package/website/types/oauth-clients.ClientSecrets.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminListItem.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminReadResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateRequest.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientReadResponse.html +1 -1
- package/website/types/qix.DocAction.html +1 -1
- package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
- package/website/types/qix.RpcObject.html +1 -1
- package/website/types/qix.UndoInfoObject.html +1 -1
- package/website/types/qix.UseAppHook.html +1 -1
- package/website/types/questions.Error.html +1 -1
- package/website/types/questions.NLMetricsResponse.html +1 -1
- package/website/types/quotas.Quota.html +1 -1
- package/website/types/reload-tasks.PostTaskBody.html +1 -1
- package/website/types/reload-tasks.PutTaskBody.html +1 -1
- package/website/types/reload-tasks.Task.html +1 -1
- package/website/types/reports.GetReportOutputsHttpError.html +4 -0
- package/website/types/reports.GetReportOutputsHttpResponse.html +6 -0
- package/website/types/reports.LinkResponse.html +2 -0
- package/website/types/reports.LinksResponse.html +7 -0
- package/website/types/reports.OutputList.html +4 -0
- package/website/types/reports.OutputListItem.html +13 -0
- package/website/types/reports.PdfOutput.html +1 -1
- package/website/types/roles.Error.html +1 -1
- package/website/types/sharing-tasks.SharingExecutionListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringResponse.html +1 -1
- package/website/types/spaces.Assignments.html +1 -1
- package/website/types/spaces.Error.html +1 -1
- package/website/types/spaces.Errors.html +1 -1
- package/website/types/spaces.SharePatch.html +1 -1
- package/website/types/spaces.Shares.html +1 -1
- package/website/types/spaces.Space.html +1 -1
- package/website/types/spaces.SpacePatch.html +1 -1
- package/website/types/spaces.Spaces.html +1 -1
- package/website/types/tasks.Action.html +1 -1
- package/website/types/tasks.Crondef.html +1 -1
- package/website/types/tasks.Eventstate.html +1 -1
- package/website/types/tasks.Functionref.html +1 -1
- package/website/types/tasks.GetTaskRunLogHttpResponse.html +1 -1
- package/website/types/tasks.Schedule.html +1 -1
- package/website/types/temp-contents.Error.html +1 -1
- package/website/types/tenants.Error.html +1 -1
- package/website/types/tenants.Tenant.html +1 -1
- package/website/types/tenants.TenantPatchErrors.html +1 -1
- package/website/types/tenants.TenantPatchSchema.html +1 -1
- package/website/types/transports.DeleteConfigNotFoundError.html +1 -1
- package/website/types/transports.SendTestMailConfigNotFoundError.html +1 -1
- package/website/types/transports.TenantAdminError.html +1 -1
- package/website/types/transports.UpdateEmailConfigError.html +1 -1
- package/website/types/transports.VerifyConnectionConfigNotFoundError.html +1 -1
- package/website/types/ui-config.JSONPatchPinnedLinkPayload.html +1 -1
- package/website/types/users.AssignedGroups.html +1 -1
- package/website/types/users.AssignedGroupsRefNames.html +1 -1
- package/website/types/users.AssignedRoles.html +1 -1
- package/website/types/users.Error.html +1 -1
- package/website/types/users.InviteErrorItem.html +1 -1
- package/website/types/users.RefIDs.html +1 -1
- package/website/types/users.RefNames.html +1 -1
- package/website/types/users.User.html +1 -1
- package/website/types/users.Users.html +1 -1
- package/website/types/web-integrations.Error.html +1 -1
- package/website/types/web-integrations.WebIntegrationPost.html +1 -1
- package/website/types/web-integrations.WebIntegrations.html +1 -1
- package/website/types/webhooks.Delivery.html +2 -2
- package/website/types/webhooks.WebhookPost.html +1 -1
- package/website/types/webhooks.WebhookResponse.html +1 -1
- package/website/variables/index.auth.html +1 -1
- package/website/variables/index.createQlikApi.html +1 -1
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
- package/website/types/di-projects.DataTaskInstanceStateOld.html +0 -3
- package/website/types/ml.ConfigurationKey.html +0 -1
- package/website/types/ml.DataSchemaConfiguration.html +0 -3
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Spaces | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/spaces.html">spaces</a></li><li><a href="" aria-current="page">Spaces</a></li></ul><h1>Type Alias Spaces</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">Spaces</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#data">data</a><span class="tsd-signature-symbol">?:</span> <a href="spaces.Space.html" class="tsd-signature-type tsd-kind-type-alias">Space</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#links">links</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">self</span><span class="tsd-signature-symbol">:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#meta">meta</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">personalSpace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">actions</span><span class="tsd-signature-symbol">:</span> <a href="spaces.ActionName.html" class="tsd-signature-type tsd-kind-type-alias">ActionName</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data?</span></a>
|
|
2
2
|
<a href="#links" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>links?</span></a>
|
|
3
3
|
<a href="#meta" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>meta?</span></a>
|
|
4
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="data"><code class="tsd-tag">Optional</code><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Space.html" class="tsd-signature-type tsd-kind-type-alias">Space</a><span class="tsd-signature-symbol">[]</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="links"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>links</span><a href="#links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">links</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">self</span><span class="tsd-signature-symbol">:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a> <span class="tsd-signature-symbol">}</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="meta"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>meta</span><a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">meta</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">personalSpace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">actions</span><span class="tsd-signature-symbol">:</span> <a href="spaces.ActionName.html" class="tsd-signature-type tsd-kind-type-alias">ActionName</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type
|
|
4
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="data"><code class="tsd-tag">Optional</code><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Space.html" class="tsd-signature-type tsd-kind-type-alias">Space</a><span class="tsd-signature-symbol">[]</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="links"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>links</span><a href="#links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">links</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">self</span><span class="tsd-signature-symbol">:</span> <a href="spaces.Link.html" class="tsd-signature-type tsd-kind-type-alias">Link</a> <span class="tsd-signature-symbol">}</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="meta"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>meta</span><a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">meta</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">personalSpace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">actions</span><span class="tsd-signature-symbol">:</span> <a href="spaces.ActionName.html" class="tsd-signature-type tsd-kind-type-alias">ActionName</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">count</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The total number of spaces matching the current filter.</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span class="tsd-kind-property">personalSpace</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">actions</span><span class="tsd-signature-symbol">:</span> <a href="spaces.ActionName.html" class="tsd-signature-type tsd-kind-type-alias">ActionName</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>The meta related to personal space when applicable.</p>
|
|
6
6
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">actions</span><span class="tsd-signature-symbol">: </span><a href="spaces.ActionName.html" class="tsd-signature-type tsd-kind-type-alias">ActionName</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>The list of actions allowed by the current user in this space.</p>
|
|
7
7
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">resourceType</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>resource type</p>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Action | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Action</a></li></ul><h1>Type Alias Action</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">condition</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">functionRef</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.Functionref.html" class="tsd-signature-type tsd-kind-type-alias">Functionref</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">nonRetryableErrors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryableErrors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryRef</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-type-declaration"><h4>Type
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Action | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Action</a></li></ul><h1>Type Alias Action</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Action</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">condition</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">functionRef</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.Functionref.html" class="tsd-signature-type tsd-kind-type-alias">Functionref</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">nonRetryableErrors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryableErrors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">retryRef</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">condition</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Expression, if defined, must evaluate to true for this action to be performed. If false, action is disregarded</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">functionRef</span><span class="tsd-signature-symbol">?: </span><a href="tasks.Functionref.html" class="tsd-signature-type tsd-kind-type-alias">Functionref</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Unique action definition name</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">nonRetryableErrors</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>List of unique references to defined workflow errors for which the action should not be retried. Used only when <code>autoRetries</code> is set to <code>true</code></p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">retryableErrors</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>List of unique references to defined workflow errors for which the action should be retried. Used only when <code>autoRetries</code> is set to <code>false</code></p>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Crondef | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Crondef</a></li></ul><h1>Type Alias Crondef</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Crondef</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">validUntil</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Crondef | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Crondef</a></li></ul><h1>Type Alias Crondef</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Crondef</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">validUntil</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul><li><span class="tsd-signature-type">string</span></li><li><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">expression</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">validUntil</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">expression</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Repeating interval (cron expression) describing when the workflow instance should be created</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">validUntil</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy & Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Eventstate | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Eventstate</a></li></ul><h1>Type Alias Eventstate</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Eventstate</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">compensatedBy</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.End.html" class="tsd-signature-type tsd-kind-type-alias">End</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">exclusive</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">onEvents</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.Onevents.html" class="tsd-signature-type tsd-kind-type-alias">Onevents</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">timeouts</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">actionExecTimeout</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.ActionExecTimeout.html" class="tsd-signature-type tsd-kind-type-alias">ActionExecTimeout</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">eventTimeout</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.EventTimeout.html" class="tsd-signature-type tsd-kind-type-alias">EventTimeout</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">stateExecTimeout</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.StateExecTimeout.html" class="tsd-signature-type tsd-kind-type-alias">StateExecTimeout</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"EVENT"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>This state is used to wait for events from event sources, then consumes them and invoke one or more actions to run in sequence or parallel</p>
|
|
2
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
2
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">compensatedBy</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Unique Name of a workflow state which is responsible for compensation of this state</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">end</span><span class="tsd-signature-symbol">?: </span><a href="tasks.End.html" class="tsd-signature-type tsd-kind-type-alias">End</a></h5><div class="tsd-comment tsd-typography"><p>State end definition</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">exclusive</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>If true consuming one of the defined events causes its associated actions to be performed. If false all of the defined events must be consumed in order for actions to be performed</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>State name</p>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Functionref | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Functionref</a></li></ul><h1>Type Alias Functionref</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Functionref</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">arguments</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">invoke</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"SYNC"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ASYNC"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">refName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"app.reload"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">selectionSet</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Functionref | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Functionref</a></li></ul><h1>Type Alias Functionref</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Functionref</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">arguments</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">invoke</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"SYNC"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ASYNC"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">refName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"app.reload"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">selectionSet</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul><li><span class="tsd-signature-type">string</span></li><li><span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">arguments</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">invoke</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"SYNC"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ASYNC"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">refName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"app.reload"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">selectionSet</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">arguments</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5><div class="tsd-comment tsd-typography"><p>Function arguments/inputs</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">invoke</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">"SYNC"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"ASYNC"</span></h5><div class="tsd-comment tsd-typography"><p>Specifies if the function should be invoked sync or async</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">refName</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"app.reload"</span></h5><div class="tsd-comment tsd-typography"><p>Name of the referenced function</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">selectionSet</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Only used if function type is 'graphql'. A string containing a valid GraphQL selection set</p>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GetTaskRunLogHttpResponse | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">GetTaskRunLogHttpResponse</a></li></ul><h1>Type Alias GetTaskRunLogHttpResponse</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">type</span> <span class="tsd-kind-type-alias">GetTaskRunLogHttpResponse</span> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#data">data</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">logContent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#headers">headers</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Headers</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#status">status</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">200</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
|
|
2
2
|
<a href="#headers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers</span></a>
|
|
3
3
|
<a href="#status" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a>
|
|
4
|
-
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="data"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">logContent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type
|
|
4
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="data"><span>data</span><a href="#data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">logContent</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">logContent</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Log content in plain text format</p>
|
|
5
5
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="headers"><span>headers</span><a href="#headers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">headers</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Headers</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="status"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">200</span></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#data"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#headers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>headers</span></a><a href="#status"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>status</span></a></div></details></div></details></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://qlik.dev/embed/" class="tsd-nav-link">Embed</a><a href="https://qlik.dev/extend/" class="tsd-nav-link">Extend</a><a href="https://qlik.dev/manage/" class="tsd-nav-link">Manage</a><a href="https://qlik.dev/apis/" class="tsd-nav-link">APIs</a><a href="https://qlik.dev/toolkits/" class="tsd-nav-link">Toolkits</a></nav><nav class="tsd-navigation"><a href="../index.html">@qlik/api reference</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><div class="wrapper"><div><img alt="Qlik logo" src="../assets/logo-footer.svg"/></div><div class="social"><a class="text" href="https://community.qlik.com/">Qlik Community</a><div class="icons"><a href="https://qlikdeveloper.slack.com/join/shared_invite/zt-1t4vc1qee-3P6R0ERUNfNeE7O6DPnN_Q#/shared-invite/email" aria-label="Qlik developer on slack"><svg viewBox="0 0 54 54" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M19.712.133a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386h5.376V5.52A5.381 5.381 0 0 0 19.712.133m0 14.365H5.376A5.381 5.381 0 0 0 0 19.884a5.381 5.381 0 0 0 5.376 5.387h14.336a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386"></path><path d="M53.76 19.884a5.381 5.381 0 0 0-5.376-5.386 5.381 5.381 0 0 0-5.376 5.386v5.387h5.376a5.381 5.381 0 0 0 5.376-5.387m-14.336 0V5.52A5.381 5.381 0 0 0 34.048.133a5.381 5.381 0 0 0-5.376 5.387v14.364a5.381 5.381 0 0 0 5.376 5.387 5.381 5.381 0 0 0 5.376-5.387"></path><path d="M34.048 54a5.381 5.381 0 0 0 5.376-5.387 5.381 5.381 0 0 0-5.376-5.386h-5.376v5.386A5.381 5.381 0 0 0 34.048 54m0-14.365h14.336a5.381 5.381 0 0 0 5.376-5.386 5.381 5.381 0 0 0-5.376-5.387H34.048a5.381 5.381 0 0 0-5.376 5.387 5.381 5.381 0 0 0 5.376 5.386"></path><path d="M0 34.249a5.381 5.381 0 0 0 5.376 5.386 5.381 5.381 0 0 0 5.376-5.386v-5.387H5.376A5.381 5.381 0 0 0 0 34.25m14.336-.001v14.364A5.381 5.381 0 0 0 19.712 54a5.381 5.381 0 0 0 5.376-5.387V34.25a5.381 5.381 0 0 0-5.376-5.387 5.381 5.381 0 0 0-5.376 5.387"></path></svg></a><a href="https://www.facebook.com/qlik" aria-label="Qlik on Facebook"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M20.05 10.345C20.05 4.812 15.56.32 10.025.32 4.491.32 0 4.812 0 10.345c0 4.852 3.449 8.893 8.02 9.825v-6.817H6.015v-3.008H8.02V7.84A3.513 3.513 0 0 1 11.53 4.33h2.506v3.008H12.03c-.551 0-1.002.451-1.002 1.002v2.005h3.007v3.008h-3.007v6.967c5.062-.5 9.022-4.772 9.022-9.975Z"/></svg></a><a href="https://www.linkedin.com/company/qlik" aria-label="Qlik on LinkedIn"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M17.286.32H3.952A3.334 3.334 0 0 0 .62 3.654v13.333a3.334 3.334 0 0 0 3.333 3.333h13.334a3.334 3.334 0 0 0 3.333-3.333V3.654A3.334 3.334 0 0 0 17.286.32Zm-10 16.25H5.202V8.237h2.084v8.333Zm.013-9.995c-.271.273-.623.412-1.055.412-.427 0-.777-.141-1.05-.425a1.46 1.46 0 0 1-.408-1.046c0-.426.137-.773.408-1.042.273-.27.623-.404 1.05-.404.432 0 .784.135 1.055.404.269.27.403.616.403 1.042 0 .43-.134.783-.403 1.059Zm9.57 9.995h-2.083v-4.63c0-1.292-.745-2.036-1.667-2.036-.445 0-.948.269-1.235.612-.288.342-.431.777-.431 1.302v4.752H9.369V8.237h2.084v1.317h.032c.614-1.013 1.506-1.517 2.678-1.521 1.665-.004 2.706 1.246 2.706 3.435v5.102Z"/></svg></a><a href="https://x.com/qlikdeveloper" aria-label="Qlik on X.com"><svg viewBox="0 0 21 21" fill="currentColor" aria-hidden="true" height="1.7rem"><path fill="currentColor" d="M11.698 8.789 18.983.32h-1.727l-6.325 7.354L5.878.32H.051l7.64 11.12-7.64 8.88h1.726l6.68-7.765 5.336 7.765h5.828L11.697 8.79Zm-2.365 2.749-.774-1.108-6.16-8.81h2.652l4.97 7.11.775 1.107 6.461 9.243h-2.652l-5.272-7.542Z"/></svg></a></div></div><div class="legal"><div class="links"><a href="https://www.qlik.com/us/legal/legal-agreements">Legal Agreements</a> /<a href="https://www.qlik.com/us/legal/legal-policies">Legal Policies</a> /<a href="https://www.qlik.com/us/legal/privacy-and-cookie-notice">Privacy & Cookie Notice</a> /<a href="https://qlik.dev/qlik-developer-portal-terms-of-use.pdf">Terms of Use</a></div><div class="copyright">Copyright © 1993-2025 QlikTech International AB. All rights reserved.</div></div></div></footer><div class="overlay"></div></body></html>
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Schedule | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Schedule</a></li></ul><h1>Type Alias Schedule</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Schedule</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">cron</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.Crondef.html" class="tsd-signature-type tsd-kind-type-alias">Crondef</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">endDateTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">recurrence</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">startDateTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">timezone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-type-declaration"><h4>Type
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Schedule | @qlik/api reference</title><meta name="description" content="Documentation for @qlik/api reference"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><nav class="tsd-toolbar-nav"><div class="tsd-toolbar-contents container"><div class="tsd-toolbar-left-section"><a class="tsd-toolbar-logo-link" href="https://qlik.dev" target="_blank" rel="noreferrer"><img class="tsd-toolbar-logo" src="../assets/logo-header.svg" alt="Qlik Logo"/></a><a href="../index.html" class="title">@qlik/api reference</a></div><div class="tsd-toolbar-right-section"><input type="checkbox" id="tsd-toolbar-nav-toggle" class="tsd-toolbar-nav-toggle" aria-label="Toggle navigation"/><label for="tsd-toolbar-nav-toggle" class="tsd-toolbar-dropdown" aria-hidden="true"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="m8 9 4.5-4.5L14 6l-4.5 4.5L8 12 2 6l1.5-1.5L8 9Z" /></svg></label><div class="tsd-toolbar-desktop-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></div><nav class="tsd-toolbar-mobile-nav"><div class="tsd-toolbar-links"><ul class="tsd-toolbar-nav-section"><li><a href="https://qlik.dev/embed/">Embed</a></li><li><a href="https://qlik.dev/extend/">Extend</a></li><li><a href="https://qlik.dev/manage/">Manage</a></li><li><a href="https://qlik.dev/apis/">APIs</a></li><li><a href="https://qlik.dev/toolkits/">Toolkits</a></li></ul></div></nav><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" aria-label="Search the docs" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 16 16" fill="currentColor"><path d="M15,4 L1,4 L1,2 L15,2 L15,4 Z M15,14 L1,14 L1,12 L15,12 L15,14 Z M15,9 L1,9 L1,7 L15,7 L15,9 Z" /></svg></a></div></div></nav><meta name="description" content="@qlik/api reference"/><link rel="icon" type="image/x-icon" href="../assets/favicon.svg"/><link rel="stylesheet" href="../assets/typedoc-qlik-style.css"/></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/tasks.html">tasks</a></li><li><a href="" aria-current="page">Schedule</a></li></ul><h1>Type Alias Schedule</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Schedule</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">cron</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.Crondef.html" class="tsd-signature-type tsd-kind-type-alias">Crondef</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">endDateTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">recurrence</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">startDateTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">timezone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul><li><span class="tsd-signature-type">string</span></li><li><span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">cron</span><span class="tsd-signature-symbol">?:</span> <a href="tasks.Crondef.html" class="tsd-signature-type tsd-kind-type-alias">Crondef</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">endDateTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">interval</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">recurrence</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">startDateTime</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">timezone</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">&</span> <span class="tsd-signature-type">unknown</span><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">cron</span><span class="tsd-signature-symbol">?: </span><a href="tasks.Crondef.html" class="tsd-signature-type tsd-kind-type-alias">Crondef</a></h5></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">endDateTime</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Specific date and time (ISO 8601 format) when the workflow instance should be terminated</p>
|
|
2
2
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">interval</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created.</p>
|
|
3
3
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">recurrence</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The RRULE recurrence string for chronos job</p>
|
|
4
4
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">startDateTime</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Specific date and time (ISO 8601 format) when the workflow instance should be created</p>
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="code"><span>code</span><a href="#code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">code</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The API error code.</p>
|
|
7
7
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="detail"><code class="tsd-tag">Optional</code><span>detail</span><a href="#detail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A human-readable problem description of the issue.</p>
|
|
8
8
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="meta"><code class="tsd-tag">Optional</code><span>meta</span><a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">meta</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">errorType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">sourceErrors</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Additional properties and information regarding the issue.</p>
|
|
9
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
9
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">errorType</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The error type.</p>
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">locale</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Locale</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">sourceErrors</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The source errors (stack trace).</p>
|
|
12
12
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="title"><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Title of the type of API Error.</p>
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="detail"><code class="tsd-tag">Optional</code><span>detail</span><a href="#detail" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">detail</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A human-readable explanation specific to this occurrence of the error.</p>
|
|
10
10
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="meta"><code class="tsd-tag">Optional</code><span>meta</span><a href="#meta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">meta</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Additional properties relating to the error.</p>
|
|
11
11
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="source"><code class="tsd-tag">Optional</code><span>source</span><a href="#source" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">source</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">parameter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">pointer</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>References to the source of the error.</p>
|
|
12
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
12
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">parameter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The URI query parameter that caused the error.</p>
|
|
13
13
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">pointer</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>A JSON Pointer to the property that caused the error.</p>
|
|
14
14
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="status"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The HTTP status code.</p>
|
|
15
15
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="title"><span>title</span><a href="#title" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">title</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>Summary of the problem.</p>
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enableanalyticcreation"><code class="tsd-tag">Optional</code><span>enable<wbr/>Analytic<wbr/>Creation</span><a href="#enableanalyticcreation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enableAnalyticCreation</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enableappopeningfeedback"><code class="tsd-tag">Optional</code><span>enable<wbr/>App<wbr/>Opening<wbr/>Feedback</span><a href="#enableappopeningfeedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">enableAppOpeningFeedback</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="hostnames"><code class="tsd-tag">Optional</code><span>hostnames</span><a href="#hostnames" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">hostnames</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>List of case insensitive hostnames that are mapped to the tenant. The first record maps to the display name and the subsequent entries are aliases.</p>
|
|
20
20
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="id"><code class="tsd-tag">Readonly</code><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unique tenant identifier.</p>
|
|
21
21
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="lastupdated"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>last<wbr/>Updated</span><a href="#lastupdated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">lastUpdated</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The timestamp for when the tenant record was last updated (1970-01-01T00:00:00.001Z for static tenants).</p>
|
|
22
|
-
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="links"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>links</span><a href="#links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">links</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">self</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">href</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type
|
|
22
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="links"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>links</span><a href="#links" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">links</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">self</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">href</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">self</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">href</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span></h5><div class="tsd-comment tsd-typography"><p>A link to this tenant.</p>
|
|
23
23
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-property">href</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>URL that defines the resource.</p>
|
|
24
24
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The display name of the tenant.</p>
|
|
25
25
|
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="region"><code class="tsd-tag">Optional</code> <code class="tsd-tag">Readonly</code><span>region</span><a href="#region" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">region</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The region where the tenant is located.</p>
|