@cas-smartdesign/data-access 5.2.0 → 5.3.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/dist/dataaccess.cjs +1 -1
- package/dist/dataaccess.cjs.map +1 -1
- package/dist/dataaccess.d.mts +202 -33
- package/dist/dataaccess.d.ts +202 -33
- package/dist/dataaccess.js +1 -1
- package/dist/dataaccess.js.map +1 -1
- package/dist/dataaccess.mjs +1 -1
- package/dist/dataaccess.mjs.map +1 -1
- package/dist/docs/assets/hierarchy.js +1 -1
- package/dist/docs/assets/navigation.js +1 -1
- package/dist/docs/assets/search.js +1 -1
- package/dist/docs/classes/FetchError.html +2 -2
- package/dist/docs/classes/RestypedFetch.html +2 -2
- package/dist/docs/classes/_internal_.CreateObjectRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.DataObjectNormalizer.html +2 -2
- package/dist/docs/classes/_internal_.DeleteAddressImageRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.DeleteDefaultRecordImageRequestBuilder.html +17 -0
- package/dist/docs/classes/_internal_.DeleteLinkRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.DeleteObjectRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.DeleteRecordImageRequestBuilder.html +17 -0
- package/dist/docs/classes/_internal_.ExtendAppSettingsRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetAddressImageAsBlobRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetAddressImageRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetAddressListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetAppSettingsRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetDefaultRecordImageAsBlobRequestBuilder.html +19 -0
- package/dist/docs/classes/_internal_.GetDefaultRecordImageRequestBuilder.html +19 -0
- package/dist/docs/classes/_internal_.GetDocumentRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetDossierCountRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetDossierEntryRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetDossierRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetEmailStoreRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetFullGroupListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetFullObjectListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetFullResourceListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetFullUserListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetGroupCountRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetGroupListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetGroupRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetItemCountForViewRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetItemsForViewRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetLoggedInUserInfoRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetLoginInformationRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetObjectDescriptionRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetObjectListCountRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetObjectListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetObjectRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetObjectSchemaRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPartialAddressListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPartialGroupListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPartialItemsForViewRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPartialObjectListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPartialResourceListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPartialUserListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetParticipantDetailsRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetParticipantInfoCountRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetParticipantInfoRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPermissionDetailsRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPermissionInfoCountRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPermissionInfoRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetPrimaryParentsListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetRecentlyUsedObjectListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetRecordImageAsBlobRequestBuilder.html +19 -0
- package/dist/docs/classes/_internal_.GetRecordImageRequestBuilder.html +19 -0
- package/dist/docs/classes/_internal_.GetRecordTypeImageRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetResourceCountRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetResourceListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetResourceRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetSchemaListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetSchemaRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetUserCountRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetUserListRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetUserRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetViewCountForTypeRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetViewForTypeRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetViewItemsRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.GetViewsForTypeRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.MaskAsRecentlyUsedDataObjectRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.PostDocumentRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.PostDossierRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.PostEmailStoreRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.PutAddressImageRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.PutDefaultRecordImageRequestBuilder.html +21 -0
- package/dist/docs/classes/_internal_.PutDocumentRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.PutObjectRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.PutRecordImageRequestBuilder.html +21 -0
- package/dist/docs/classes/_internal_.QueryRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.RequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.ServerVersionRequestBuilder.html +2 -2
- package/dist/docs/classes/_internal_.SetAppSettingsRequestBuilder.html +2 -2
- package/dist/docs/enums/DatePrecision.html +6 -6
- package/dist/docs/functions/create.html +1 -1
- package/dist/docs/hierarchy.html +1 -1
- package/dist/docs/interfaces/IAPIResponse.html +2 -2
- package/dist/docs/interfaces/IAPIVersions.html +2 -2
- package/dist/docs/interfaces/IAddressService.html +7 -7
- package/dist/docs/interfaces/IAppointmentService.html +4 -4
- package/dist/docs/interfaces/IDataObjectImagePart.html +3 -0
- package/dist/docs/interfaces/IDataObjectLinkQueryParameters.html +1 -1
- package/dist/docs/interfaces/IDataObjectQueryParameters.html +1 -1
- package/dist/docs/interfaces/IDataObjectSchemaPart.html +1 -1
- package/dist/docs/interfaces/IDataObjectTransferable.html +1 -1
- package/dist/docs/interfaces/IDataObjectTypeIconPart.html +2 -0
- package/dist/docs/interfaces/IDataObjectTypesQueryParameter.html +1 -1
- package/dist/docs/interfaces/IDateTimeField.html +1 -1
- package/dist/docs/interfaces/IDecimalField.html +1 -1
- package/dist/docs/interfaces/IDecimalSuggestField.html +1 -1
- package/dist/docs/interfaces/IDocumentService.html +4 -4
- package/dist/docs/interfaces/IDomainQueryParameter.html +1 -1
- package/dist/docs/interfaces/IDossierQueryParameters.html +1 -1
- package/dist/docs/interfaces/IDoubleField.html +1 -1
- package/dist/docs/interfaces/IDoubleSuggestField.html +1 -1
- package/dist/docs/interfaces/IEmailStoreService.html +3 -3
- package/dist/docs/interfaces/IFavoriteQueryParameter.html +1 -1
- package/dist/docs/interfaces/IFetchWrapper.html +2 -2
- package/dist/docs/interfaces/IGguidField.html +1 -1
- package/dist/docs/interfaces/IGroupService.html +5 -5
- package/dist/docs/interfaces/IGwSpecific.html +2 -2
- package/dist/docs/interfaces/IHasFormatOption.html +1 -1
- package/dist/docs/interfaces/IHasLength.html +1 -1
- package/dist/docs/interfaces/IHasMaxLength.html +1 -1
- package/dist/docs/interfaces/IHasOverflowLength.html +1 -1
- package/dist/docs/interfaces/IHasPrecision.html +1 -1
- package/dist/docs/interfaces/IHasPrecisionAndScale.html +1 -1
- package/dist/docs/interfaces/IHasSystemDefinedTranslated.html +1 -1
- package/dist/docs/interfaces/IIncludeMaxJournalIdQueryParameter.html +1 -1
- package/dist/docs/interfaces/IIncludePermissionsQueryParameter.html +1 -1
- package/dist/docs/interfaces/IIntField.html +1 -1
- package/dist/docs/interfaces/IIntSuggestField.html +1 -1
- package/dist/docs/interfaces/IInterPlatform.html +2 -3
- package/dist/docs/interfaces/ILastUsedDataObjectQueryParameters.html +1 -1
- package/dist/docs/interfaces/ILinkingService.html +8 -8
- package/dist/docs/interfaces/IOpenSpecific.html +2 -2
- package/dist/docs/interfaces/IOrderByQueryParameters.html +1 -1
- package/dist/docs/interfaces/IPagedQueryParameters.html +1 -1
- package/dist/docs/interfaces/IPartialObjectQueryParameters.html +1 -1
- package/dist/docs/interfaces/IPermissionRequirementQueryParameter.html +1 -1
- package/dist/docs/interfaces/IQueryPart.html +1 -1
- package/dist/docs/interfaces/IRecentlyUsedQueryParameter.html +1 -1
- package/dist/docs/interfaces/IResourceQueryParameters.html +1 -1
- package/dist/docs/interfaces/IResourceService.html +5 -5
- package/dist/docs/interfaces/ISearchQueryParameters.html +1 -1
- package/dist/docs/interfaces/ISelectionValueListField.html +1 -1
- package/dist/docs/interfaces/IServerInformationService.html +2 -2
- package/dist/docs/interfaces/IServerSpecificVersionAPIDefinition.html +2 -2
- package/dist/docs/interfaces/IServerVersionPart.html +1 -1
- package/dist/docs/interfaces/IServiceRegistry.html +14 -14
- package/dist/docs/interfaces/ISettingsService.html +9 -9
- package/dist/docs/interfaces/ISingleDataObjectQueryParameters.html +1 -1
- package/dist/docs/interfaces/ISingleDataObjectTypesQueryParameter.html +1 -1
- package/dist/docs/interfaces/IStringField.html +1 -1
- package/dist/docs/interfaces/IStringListSuggestField.html +1 -1
- package/dist/docs/interfaces/IStringSuggestField.html +1 -1
- package/dist/docs/interfaces/ISuggestField.html +1 -1
- package/dist/docs/interfaces/ISuggestionWithRawValue.html +2 -2
- package/dist/docs/interfaces/ITeamFilterQueryParameters.html +1 -1
- package/dist/docs/interfaces/ITextField.html +1 -1
- package/dist/docs/interfaces/ITypedJSONResponse.html +2 -2
- package/dist/docs/interfaces/ITypedRequestInit.html +2 -2
- package/dist/docs/interfaces/IUserService.html +9 -9
- package/dist/docs/interfaces/IVersion6.html +2 -2
- package/dist/docs/interfaces/IVersion7.html +2 -2
- package/dist/docs/interfaces/IViewItemsCountQueryParameters.html +1 -1
- package/dist/docs/interfaces/IViewItemsQueryParameters.html +1 -1
- package/dist/docs/interfaces/IViewKindQueryParameters.html +1 -1
- package/dist/docs/interfaces/IViewQueryParameters.html +1 -1
- package/dist/docs/interfaces/IViewService.html +7 -7
- package/dist/docs/interfaces/IWhereStringQueryParameters.html +1 -1
- package/dist/docs/interfaces/{IDataObjectService.html → _internal_.ICommonDataObjectService.html} +17 -28
- package/dist/docs/interfaces/_internal_.IDataObjectImageService.html +44 -0
- package/dist/docs/interfaces/_internal_.IDataObjectTypeIconService.html +11 -0
- package/dist/docs/modules/_internal_.html +1 -1
- package/dist/docs/modules.html +1 -1
- package/dist/docs/types/APIVersion.html +1 -1
- package/dist/docs/types/FieldCommon.html +1 -1
- package/dist/docs/types/FieldCommon7.html +1 -1
- package/dist/docs/types/FieldGw7.html +1 -1
- package/dist/docs/types/FieldTypes.html +1 -1
- package/dist/docs/types/FieldTypesV6.html +1 -1
- package/dist/docs/types/FieldTypesV7.html +1 -1
- package/dist/docs/types/IDataObjectService.html +2 -0
- package/dist/docs/types/InterPlatform6.html +1 -1
- package/dist/docs/types/InterPlatform6Common.html +1 -1
- package/dist/docs/types/InterPlatform6Gw.html +1 -1
- package/dist/docs/types/InterPlatform6Open.html +1 -1
- package/dist/docs/types/InterPlatform7.html +1 -1
- package/dist/docs/types/InterPlatform7Common.html +1 -1
- package/dist/docs/types/InterPlatform7Gw.html +1 -1
- package/dist/docs/types/InterPlatform7Open.html +1 -1
- package/dist/docs/types/InterPlatformGw.html +1 -1
- package/dist/docs/types/InterPlatformOpen.html +1 -1
- package/dist/docs/types/Methods.html +1 -1
- package/dist/docs/types/OmitProp.html +1 -1
- package/dist/docs/types/ServerType.html +1 -1
- package/dist/docs/types/V7SuggestField.html +1 -1
- package/package.json +1 -1
|
@@ -1,21 +1,21 @@
|
|
|
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>ISettingsService | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">ISettingsService</a></li></ul><h1>Interface ISettingsService<PLATFORM></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Provides methods to retrieve information about settings and to get or set the settings themselves.</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ISettingsService</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a> <span class="tsd-signature-keyword">extends</span> <a href="IInterPlatform.html" class="tsd-signature-type tsd-kind-interface">IInterPlatform</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#changeappsettings-1">changeAppSettings</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</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-parameter">appId</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-parameter">settings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a><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> <a href="../classes/_internal_.ExtendAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">ExtendAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getappsettings-1">getAppSettings</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">appId</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> <a href="../classes/_internal_.GetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span><br/> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getschema-1">getSchema</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</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> <a href="../classes/_internal_.GetSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getschemalist-1">getSchemaList</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.GetSchemaListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaListRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#setappsettings-1">setAppSettings</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">appId</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-parameter">settings</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.SetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">SetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="platform"><span class="tsd-kind-type-parameter">PLATFORM</span> <span class="tsd-signature-keyword">extends</span> <a href="IInterPlatform.html" class="tsd-signature-type tsd-kind-interface">IInterPlatform</a></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ISettingsService</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a> <span class="tsd-signature-keyword">extends</span> <a href="IInterPlatform.html" class="tsd-signature-type tsd-kind-interface">IInterPlatform</a><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-call-signature" href="#changeappsettings-1">changeAppSettings</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</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-parameter">appId</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-parameter">settings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a><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> <a href="../classes/_internal_.ExtendAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">ExtendAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getappsettings-1">getAppSettings</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">appId</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> <a href="../classes/_internal_.GetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span><br/> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">,</span><br/> <a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getschema-1">getSchema</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</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> <a href="../classes/_internal_.GetSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#getschemalist-1">getSchemaList</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.GetSchemaListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaListRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-call-signature" href="#setappsettings-1">setAppSettings</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">appId</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-parameter">settings</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.SetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">SetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="platform"><span class="tsd-kind-type-parameter">PLATFORM</span> <span class="tsd-signature-keyword">extends</span> <a href="IInterPlatform.html" class="tsd-signature-type tsd-kind-interface">IInterPlatform</a></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:2313</li></ul></aside><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">Methods</h3><div class="tsd-index-list"><a href="#changeappsettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>App<wbr/>Settings</span></a>
|
|
3
3
|
<a href="#getappsettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>App<wbr/>Settings</span></a>
|
|
4
4
|
<a href="#getschema" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema</span></a>
|
|
5
5
|
<a href="#getschemalist" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema<wbr/>List</span></a>
|
|
6
6
|
<a href="#setappsettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>App<wbr/>Settings</span></a>
|
|
7
7
|
</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-Methods"><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>Methods</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="changeappsettings"><span>change<wbr/>App<wbr/>Settings</span><a href="#changeappsettings" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="changeappsettings-1"><span class="tsd-kind-call-signature">changeAppSettings</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">appId</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-parameter">settings</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a><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> <a href="../classes/_internal_.ExtendAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">ExtendAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span><a href="#changeappsettings-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Changes the settings for the given app withing the scope partially. By default, the user settings are changed. To change the global settings,
|
|
8
|
-
use the SetAppSettingsRequestBuilder.withScope method on the returned builder. Note that setting the global settings
|
|
8
|
+
use the [[SetAppSettingsRequestBuilder.withScope]] method on the returned builder. Note that setting the global settings
|
|
9
9
|
needs administrator privileges.</p>
|
|
10
10
|
<p>Properties that are absent on the given settings object will be left untouched.</p>
|
|
11
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="changeappsettingssettingstype"><span class="tsd-kind-type-parameter">SETTINGSTYPE</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> = <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">settings</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.ExtendAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">ExtendAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:
|
|
11
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="changeappsettingssettingstype"><span class="tsd-kind-type-parameter">SETTINGSTYPE</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> = <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">settings</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#changeappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">></span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.ExtendAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">ExtendAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:2345</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getappsettings"><span>get<wbr/>App<wbr/>Settings</span><a href="#getappsettings" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getappsettings-1"><span class="tsd-kind-call-signature">getAppSettings</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">appId</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> <a href="../classes/_internal_.GetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">></span><a href="#getappsettings-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the effective settings stored for the given app. The effective settings contains all the properties
|
|
12
12
|
that affects the current user, including the global properties and the schema defaults as fallback.</p>
|
|
13
13
|
<p>To get the settings only for the user or global
|
|
14
|
-
scope, use the GetAppSettingsRequestBuilder.withScope method on the returned builder.</p>
|
|
15
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getappsettingssettingstype"><span class="tsd-kind-type-parameter">SETTINGSTYPE</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> = <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:
|
|
16
|
-
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:
|
|
17
|
-
</div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetSchemaListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaListRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:
|
|
18
|
-
use the SetAppSettingsRequestBuilder.withScope method on the returned builder. Note that setting the global settings
|
|
14
|
+
scope, use the [[GetAppSettingsRequestBuilder.withScope]] method on the returned builder.</p>
|
|
15
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="getappsettingssettingstype"><span class="tsd-kind-type-parameter">SETTINGSTYPE</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> = <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">,</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#getappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:2329</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getschema"><span>get<wbr/>Schema</span><a href="#getschema" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getschema-1"><span class="tsd-kind-call-signature">getSchema</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">appId</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> <a href="../classes/_internal_.GetSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span><a href="#getschema-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the settings schema for the given app. If the app has no schema, an empty one will be returned.</p>
|
|
16
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:2321</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getschemalist"><span>get<wbr/>Schema<wbr/>List</span><a href="#getschemalist" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getschemalist-1"><span class="tsd-kind-call-signature">getSchemaList</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.GetSchemaListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaListRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span><a href="#getschemalist-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Gets the settings schema for apps where it's defined.</p>
|
|
17
|
+
</div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetSchemaListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetSchemaListRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:2317</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setappsettings"><span>set<wbr/>App<wbr/>Settings</span><a href="#setappsettings" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setappsettings-1"><span class="tsd-kind-call-signature">setAppSettings</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> <span class="tsd-signature-symbol">=</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">appId</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-parameter">settings</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.SetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">SetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span><a href="#setappsettings-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Replaces all settings for the given app withing the scope. By default, the user settings are changed. To change the global settings,
|
|
18
|
+
use the [[SetAppSettingsRequestBuilder.withScope]] method on the returned builder. Note that setting the global settings
|
|
19
19
|
needs administrator privileges.</p>
|
|
20
20
|
<p>Properties that are absent on the given settings object will removed on the scope.</p>
|
|
21
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="setappsettingssettingstype"><span class="tsd-kind-type-parameter">SETTINGSTYPE</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> = <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">settings</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.SetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">SetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:
|
|
21
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span id="setappsettingssettingstype"><span class="tsd-kind-type-parameter">SETTINGSTYPE</span> <span class="tsd-signature-keyword">extends</span> <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a> = <a href="../types/AppSettingsValues.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsValues</a></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">settings</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#setappsettingssettingstype">SETTINGSTYPE</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.SetAppSettingsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">SetAppSettingsRequestBuilder</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="../types/AppSettingsEndpoint.html" class="tsd-signature-type tsd-kind-type-alias">AppSettingsEndpoint</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:2337</li></ul></aside></div></li></ul></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></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-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#changeappsettings"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>change<wbr/>App<wbr/>Settings</span></a><a href="#getappsettings"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>App<wbr/>Settings</span></a><a href="#getschema"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema</span></a><a href="#getschemalist"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Schema<wbr/>List</span></a><a href="#setappsettings"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>App<wbr/>Settings</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@cas-smartdesign/data-access</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></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>ISingleDataObjectQueryParameters | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">ISingleDataObjectQueryParameters</a></li></ul><h1>Interface ISingleDataObjectQueryParameters</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ISingleDataObjectQueryParameters</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#fields">fields</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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="#includemaxjournalid">includeMaxjournalid</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includepermissions">includePermissions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includesyncrecordpermissions">includeSyncrecordPermissions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#isfavorite">isfavorite</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tagasrecentlyused">tagAsRecentlyUsed</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
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>ISingleDataObjectQueryParameters | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">ISingleDataObjectQueryParameters</a></li></ul><h1>Interface ISingleDataObjectQueryParameters</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ISingleDataObjectQueryParameters</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#fields">fields</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</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="#includemaxjournalid">includeMaxjournalid</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includepermissions">includePermissions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#includesyncrecordpermissions">includeSyncrecordPermissions</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#isfavorite">isfavorite</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#tagasrecentlyused">tagAsRecentlyUsed</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1490"><h4>Hierarchy (<a href="../hierarchy.html#ISingleDataObjectQueryParameters">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="IPartialObjectQueryParameters.html" class="tsd-signature-type tsd-kind-interface">IPartialObjectQueryParameters</a></li><li class="tsd-hierarchy-item"><a href="IIncludePermissionsQueryParameter.html" class="tsd-signature-type tsd-kind-interface">IIncludePermissionsQueryParameter</a></li><li class="tsd-hierarchy-item"><a href="IRecentlyUsedQueryParameter.html" class="tsd-signature-type tsd-kind-interface">IRecentlyUsedQueryParameter</a></li><li class="tsd-hierarchy-item"><a href="IFavoriteQueryParameter.html" class="tsd-signature-type tsd-kind-interface">IFavoriteQueryParameter</a></li><li class="tsd-hierarchy-item"><a href="IIncludeMaxJournalIdQueryParameter.html" class="tsd-signature-type tsd-kind-interface">IIncludeMaxJournalIdQueryParameter</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ISingleDataObjectQueryParameters</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:525</li></ul></aside><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="#fields" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>fields?</span></a>
|
|
2
2
|
<a href="#includemaxjournalid" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Maxjournalid?</span></a>
|
|
3
3
|
<a href="#includepermissions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Permissions?</span></a>
|
|
4
4
|
<a href="#includesyncrecordpermissions" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>include<wbr/>Syncrecord<wbr/>Permissions?</span></a>
|
|
@@ -1,2 +1,2 @@
|
|
|
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>ISingleDataObjectTypesQueryParameter | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">ISingleDataObjectTypesQueryParameter</a></li></ul><h1>Interface ISingleDataObjectTypesQueryParameter</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ISingleDataObjectTypesQueryParameter</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#objecttype">objectType</a><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><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
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>ISingleDataObjectTypesQueryParameter | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">ISingleDataObjectTypesQueryParameter</a></li></ul><h1>Interface ISingleDataObjectTypesQueryParameter</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ISingleDataObjectTypesQueryParameter</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#objecttype">objectType</a><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><section class="tsd-panel tsd-hierarchy" data-refl="1497"><h4>Hierarchy (<a href="../hierarchy.html#ISingleDataObjectTypesQueryParameter">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ISingleDataObjectTypesQueryParameter</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="IResourceQueryParameters.html" class="tsd-signature-type tsd-kind-interface">IResourceQueryParameters</a></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:497</li></ul></aside><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="#objecttype" 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>object<wbr/>Type?</span></a>
|
|
2
2
|
</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="objecttype"><code class="tsd-tag">Optional</code><span>object<wbr/>Type</span><a href="#objecttype" 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">objectType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:498</li></ul></aside></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></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="#objecttype"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>object<wbr/>Type</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@cas-smartdesign/data-access</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></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>IStringField | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">IStringField</a></li></ul><h1>Interface IStringField</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IStringField</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#accesspermission">accessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#allowedformassupdate">allowedForMassUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#custom">custom</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displayname">displayname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displaynameshort">displaynameShort</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#duplicatable">duplicatable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#inlisteditable">inListEditable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mandatory">mandatory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxlength">maxLength</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minaccesspermission">minAccessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#optional">optional</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#recommended">recommended</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemdefinedtranslated">systemDefinedTranslated</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemfield">systemField</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"STRING"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateable">updateable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
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>IStringField | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">IStringField</a></li></ul><h1>Interface IStringField</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IStringField</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#accesspermission">accessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#allowedformassupdate">allowedForMassUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#custom">custom</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displayname">displayname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displaynameshort">displaynameShort</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#duplicatable">duplicatable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#inlisteditable">inListEditable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mandatory">mandatory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxlength">maxLength</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minaccesspermission">minAccessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#optional">optional</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#recommended">recommended</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemdefinedtranslated">systemDefinedTranslated</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemfield">systemField</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"STRING"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateable">updateable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1499"><h4>Hierarchy (<a href="../hierarchy.html#IStringField">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="ICommonField.html" class="tsd-signature-type tsd-kind-interface">ICommonField</a></li><li class="tsd-hierarchy-item"><a href="IHasMaxLength.html" class="tsd-signature-type tsd-kind-interface">IHasMaxLength</a></li><li class="tsd-hierarchy-item"><a href="IHasSystemDefinedTranslated.html" class="tsd-signature-type tsd-kind-interface">IHasSystemDefinedTranslated</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IStringField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:231</li></ul></aside><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="#accesspermission" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Permission</span></a>
|
|
2
2
|
<a href="#allowedformassupdate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allowed<wbr/>For<wbr/>Mass<wbr/>Update</span></a>
|
|
3
3
|
<a href="#custom" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom</span></a>
|
|
4
4
|
<a href="#displayname" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>displayname</span></a>
|
|
@@ -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>IStringListSuggestField | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">IStringListSuggestField</a></li></ul><h1>Interface IStringListSuggestField</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IStringListSuggestField</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#accesspermission">accessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#allowedformassupdate">allowedForMassUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#custom">custom</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#customvalueallowed">customValueAllowed</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displayname">displayname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displaynameshort">displaynameShort</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#duplicatable">duplicatable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#inlisteditable">inListEditable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mandatory">mandatory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxlength">maxLength</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minaccesspermission">minAccessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#optional">optional</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#recommended">recommended</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#suggestedvalues">suggestedValues</a><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="#systemdefinedtranslated">systemDefinedTranslated</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemfield">systemField</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"STRINGLISTSUGGEST"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateable">updateable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
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>IStringListSuggestField | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">IStringListSuggestField</a></li></ul><h1>Interface IStringListSuggestField</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IStringListSuggestField</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#accesspermission">accessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#allowedformassupdate">allowedForMassUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#custom">custom</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#customvalueallowed">customValueAllowed</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displayname">displayname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displaynameshort">displaynameShort</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#duplicatable">duplicatable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#inlisteditable">inListEditable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mandatory">mandatory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxlength">maxLength</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minaccesspermission">minAccessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#optional">optional</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#recommended">recommended</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#suggestedvalues">suggestedValues</a><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="#systemdefinedtranslated">systemDefinedTranslated</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemfield">systemField</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"STRINGLISTSUGGEST"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateable">updateable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1523"><h4>Hierarchy (<a href="../hierarchy.html#IStringListSuggestField">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="ICommonField.html" class="tsd-signature-type tsd-kind-interface">ICommonField</a></li><li class="tsd-hierarchy-item"><a href="ISuggestField.html" class="tsd-signature-type tsd-kind-interface">ISuggestField</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-hierarchy-item"><a href="IHasMaxLength.html" class="tsd-signature-type tsd-kind-interface">IHasMaxLength</a></li><li class="tsd-hierarchy-item"><a href="IHasSystemDefinedTranslated.html" class="tsd-signature-type tsd-kind-interface">IHasSystemDefinedTranslated</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IStringListSuggestField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:207</li></ul></aside><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="#accesspermission" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Permission</span></a>
|
|
2
2
|
<a href="#allowedformassupdate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allowed<wbr/>For<wbr/>Mass<wbr/>Update</span></a>
|
|
3
3
|
<a href="#custom" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom</span></a>
|
|
4
4
|
<a href="#customvalueallowed" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom<wbr/>Value<wbr/>Allowed</span></a>
|
|
@@ -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>IStringSuggestField | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">IStringSuggestField</a></li></ul><h1>Interface IStringSuggestField</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IStringSuggestField</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#accesspermission">accessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#allowedformassupdate">allowedForMassUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#custom">custom</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#customvalueallowed">customValueAllowed</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displayname">displayname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displaynameshort">displaynameShort</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#duplicatable">duplicatable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#inlisteditable">inListEditable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mandatory">mandatory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxlength">maxLength</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minaccesspermission">minAccessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#optional">optional</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#recommended">recommended</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#suggestedvalues">suggestedValues</a><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="#systemdefinedtranslated">systemDefinedTranslated</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemfield">systemField</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"STRINGSUGGEST"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateable">updateable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="
|
|
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>IStringSuggestField | @cas-smartdesign/data-access</title><meta name="description" content="Documentation for @cas-smartdesign/data-access"/><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><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></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"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@cas-smartdesign/data-access</a><div id="tsd-toolbar-links"></div><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" 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 width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></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="" aria-current="page">IStringSuggestField</a></li></ul><h1>Interface IStringSuggestField</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IStringSuggestField</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="#accesspermission">accessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#allowedformassupdate">allowedForMassUpdate</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#custom">custom</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#customvalueallowed">customValueAllowed</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displayname">displayname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#displaynameshort">displaynameShort</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#duplicatable">duplicatable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#hidden">hidden</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#inlisteditable">inListEditable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#mandatory">mandatory</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#maxlength">maxLength</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#minaccesspermission">minAccessPermission</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#name">name</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#optional">optional</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#recommended">recommended</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#suggestedvalues">suggestedValues</a><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="#systemdefinedtranslated">systemDefinedTranslated</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#systemfield">systemField</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#type">type</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"STRINGSUGGEST"</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="#updateable">updateable</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="1545"><h4>Hierarchy (<a href="../hierarchy.html#IStringSuggestField">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="ICommonField.html" class="tsd-signature-type tsd-kind-interface">ICommonField</a></li><li class="tsd-hierarchy-item"><a href="ISuggestField.html" class="tsd-signature-type tsd-kind-interface">ISuggestField</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-hierarchy-item"><a href="IHasMaxLength.html" class="tsd-signature-type tsd-kind-interface">IHasMaxLength</a></li><li class="tsd-hierarchy-item"><a href="IHasSystemDefinedTranslated.html" class="tsd-signature-type tsd-kind-interface">IHasSystemDefinedTranslated</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">IStringSuggestField</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:204</li></ul></aside><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="#accesspermission" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>access<wbr/>Permission</span></a>
|
|
2
2
|
<a href="#allowedformassupdate" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allowed<wbr/>For<wbr/>Mass<wbr/>Update</span></a>
|
|
3
3
|
<a href="#custom" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom</span></a>
|
|
4
4
|
<a href="#customvalueallowed" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom<wbr/>Value<wbr/>Allowed</span></a>
|