@cas-smartdesign/data-access 5.1.4 → 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.
Files changed (270) hide show
  1. package/dist/dataaccess.cjs +1 -1
  2. package/dist/dataaccess.cjs.map +1 -1
  3. package/dist/dataaccess.d.mts +202 -33
  4. package/dist/dataaccess.d.ts +202 -33
  5. package/dist/dataaccess.js +1 -2
  6. package/dist/dataaccess.js.map +1 -1
  7. package/dist/dataaccess.mjs +1 -1
  8. package/dist/dataaccess.mjs.map +1 -1
  9. package/dist/docs/assets/hierarchy.js +1 -0
  10. package/dist/docs/assets/icons.js +18 -0
  11. package/dist/docs/assets/icons.svg +1 -0
  12. package/dist/docs/assets/main.js +5 -4
  13. package/dist/docs/assets/navigation.js +1 -1
  14. package/dist/docs/assets/search.js +1 -1
  15. package/dist/docs/assets/style.css +1446 -1227
  16. package/dist/docs/classes/FetchError.html +5 -5
  17. package/dist/docs/classes/PrimaryLinkedParent.html +6 -6
  18. package/dist/docs/classes/RestypedFetch.html +10 -15
  19. package/dist/docs/classes/TeamFilter.html +5 -5
  20. package/dist/docs/classes/_internal_.CreateObjectRequestBuilder.html +20 -21
  21. package/dist/docs/classes/_internal_.DataObjectNormalizer.html +4 -4
  22. package/dist/docs/classes/_internal_.DeleteAddressImageRequestBuilder.html +17 -17
  23. package/dist/docs/classes/_internal_.DeleteDefaultRecordImageRequestBuilder.html +17 -0
  24. package/dist/docs/classes/_internal_.DeleteLinkRequestBuilder.html +17 -17
  25. package/dist/docs/classes/_internal_.DeleteObjectRequestBuilder.html +17 -17
  26. package/dist/docs/classes/_internal_.DeleteRecordImageRequestBuilder.html +17 -0
  27. package/dist/docs/classes/_internal_.ExtendAppSettingsRequestBuilder.html +18 -20
  28. package/dist/docs/classes/_internal_.GetAddressImageAsBlobRequestBuilder.html +19 -19
  29. package/dist/docs/classes/_internal_.GetAddressImageRequestBuilder.html +19 -19
  30. package/dist/docs/classes/_internal_.GetAddressListRequestBuilder.html +33 -33
  31. package/dist/docs/classes/_internal_.GetAppSettingsRequestBuilder.html +18 -19
  32. package/dist/docs/classes/_internal_.GetDefaultRecordImageAsBlobRequestBuilder.html +19 -0
  33. package/dist/docs/classes/_internal_.GetDefaultRecordImageRequestBuilder.html +19 -0
  34. package/dist/docs/classes/_internal_.GetDocumentRequestBuilder.html +19 -19
  35. package/dist/docs/classes/_internal_.GetDossierCountRequestBuilder.html +17 -17
  36. package/dist/docs/classes/_internal_.GetDossierEntryRequestBuilder.html +17 -17
  37. package/dist/docs/classes/_internal_.GetDossierRequestBuilder.html +20 -20
  38. package/dist/docs/classes/_internal_.GetEmailStoreRequestBuilder.html +18 -18
  39. package/dist/docs/classes/_internal_.GetFullGroupListRequestBuilder.html +24 -24
  40. package/dist/docs/classes/_internal_.GetFullObjectListRequestBuilder.html +31 -31
  41. package/dist/docs/classes/_internal_.GetFullResourceListRequestBuilder.html +24 -24
  42. package/dist/docs/classes/_internal_.GetFullUserListRequestBuilder.html +24 -24
  43. package/dist/docs/classes/_internal_.GetGroupCountRequestBuilder.html +19 -19
  44. package/dist/docs/classes/_internal_.GetGroupListRequestBuilder.html +24 -24
  45. package/dist/docs/classes/_internal_.GetGroupRequestBuilder.html +19 -19
  46. package/dist/docs/classes/_internal_.GetItemCountForViewRequestBuilder.html +22 -22
  47. package/dist/docs/classes/_internal_.GetItemsForViewRequestBuilder.html +29 -29
  48. package/dist/docs/classes/_internal_.GetLoggedInUserInfoRequestBuilder.html +20 -20
  49. package/dist/docs/classes/_internal_.GetLoginInformationRequestBuilder.html +17 -17
  50. package/dist/docs/classes/_internal_.GetObjectDescriptionRequestBuilder.html +17 -17
  51. package/dist/docs/classes/_internal_.GetObjectListCountRequestBuilder.html +25 -25
  52. package/dist/docs/classes/_internal_.GetObjectListRequestBuilder.html +31 -31
  53. package/dist/docs/classes/_internal_.GetObjectRequestBuilder.html +24 -24
  54. package/dist/docs/classes/_internal_.GetObjectSchemaRequestBuilder.html +17 -18
  55. package/dist/docs/classes/_internal_.GetPartialAddressListRequestBuilder.html +33 -33
  56. package/dist/docs/classes/_internal_.GetPartialGroupListRequestBuilder.html +24 -24
  57. package/dist/docs/classes/_internal_.GetPartialItemsForViewRequestBuilder.html +29 -29
  58. package/dist/docs/classes/_internal_.GetPartialObjectListRequestBuilder.html +31 -31
  59. package/dist/docs/classes/_internal_.GetPartialResourceListRequestBuilder.html +24 -24
  60. package/dist/docs/classes/_internal_.GetPartialUserListRequestBuilder.html +24 -24
  61. package/dist/docs/classes/_internal_.GetParticipantDetailsRequestBuilder.html +17 -17
  62. package/dist/docs/classes/_internal_.GetParticipantInfoCountRequestBuilder.html +17 -17
  63. package/dist/docs/classes/_internal_.GetParticipantInfoRequestBuilder.html +17 -17
  64. package/dist/docs/classes/_internal_.GetPermissionDetailsRequestBuilder.html +17 -17
  65. package/dist/docs/classes/_internal_.GetPermissionInfoCountRequestBuilder.html +17 -17
  66. package/dist/docs/classes/_internal_.GetPermissionInfoRequestBuilder.html +17 -17
  67. package/dist/docs/classes/_internal_.GetPrimaryParentsListRequestBuilder.html +17 -17
  68. package/dist/docs/classes/_internal_.GetRecentlyUsedObjectListRequestBuilder.html +19 -19
  69. package/dist/docs/classes/_internal_.GetRecordImageAsBlobRequestBuilder.html +19 -0
  70. package/dist/docs/classes/_internal_.GetRecordImageRequestBuilder.html +19 -0
  71. package/dist/docs/classes/_internal_.GetRecordTypeImageRequestBuilder.html +18 -18
  72. package/dist/docs/classes/_internal_.GetResourceCountRequestBuilder.html +19 -19
  73. package/dist/docs/classes/_internal_.GetResourceListRequestBuilder.html +24 -24
  74. package/dist/docs/classes/_internal_.GetResourceRequestBuilder.html +19 -19
  75. package/dist/docs/classes/_internal_.GetSchemaListRequestBuilder.html +17 -17
  76. package/dist/docs/classes/_internal_.GetSchemaRequestBuilder.html +17 -17
  77. package/dist/docs/classes/_internal_.GetUserCountRequestBuilder.html +19 -19
  78. package/dist/docs/classes/_internal_.GetUserListRequestBuilder.html +24 -24
  79. package/dist/docs/classes/_internal_.GetUserRequestBuilder.html +20 -20
  80. package/dist/docs/classes/_internal_.GetViewCountForTypeRequestBuilder.html +17 -17
  81. package/dist/docs/classes/_internal_.GetViewForTypeRequestBuilder.html +17 -17
  82. package/dist/docs/classes/_internal_.GetViewItemsRequestBuilder.html +29 -29
  83. package/dist/docs/classes/_internal_.GetViewsForTypeRequestBuilder.html +20 -20
  84. package/dist/docs/classes/_internal_.MaskAsRecentlyUsedDataObjectRequestBuilder.html +17 -17
  85. package/dist/docs/classes/_internal_.PostDocumentRequestBuilder.html +21 -22
  86. package/dist/docs/classes/_internal_.PostDossierRequestBuilder.html +24 -24
  87. package/dist/docs/classes/_internal_.PostEmailStoreRequestBuilder.html +23 -25
  88. package/dist/docs/classes/_internal_.PutAddressImageRequestBuilder.html +21 -22
  89. package/dist/docs/classes/_internal_.PutDefaultRecordImageRequestBuilder.html +21 -0
  90. package/dist/docs/classes/_internal_.PutDocumentRequestBuilder.html +24 -27
  91. package/dist/docs/classes/_internal_.PutObjectRequestBuilder.html +18 -18
  92. package/dist/docs/classes/_internal_.PutRecordImageRequestBuilder.html +21 -0
  93. package/dist/docs/classes/_internal_.QueryRequestBuilder.html +20 -22
  94. package/dist/docs/classes/_internal_.RequestBuilder.html +17 -22
  95. package/dist/docs/classes/_internal_.ServerVersionRequestBuilder.html +17 -18
  96. package/dist/docs/classes/_internal_.SetAppSettingsRequestBuilder.html +18 -20
  97. package/dist/docs/enums/AccessRight.html +17 -17
  98. package/dist/docs/enums/DatePrecision.html +11 -11
  99. package/dist/docs/enums/ForeignEditPermission.html +17 -17
  100. package/dist/docs/enums/HtmlFilter.html +13 -13
  101. package/dist/docs/enums/TeamFilterConstant.html +4 -4
  102. package/dist/docs/functions/create.html +6 -6
  103. package/dist/docs/hierarchy.html +1 -1
  104. package/dist/docs/index.html +5 -5
  105. package/dist/docs/interfaces/IAPIResponse.html +3 -3
  106. package/dist/docs/interfaces/IAPIVersions.html +3 -3
  107. package/dist/docs/interfaces/IAddressRelatedPermissionOwnerInfoFields.html +21 -21
  108. package/dist/docs/interfaces/IAddressService.html +19 -19
  109. package/dist/docs/interfaces/IAddressSpecificQueryParameters.html +3 -3
  110. package/dist/docs/interfaces/IAppointmentService.html +12 -12
  111. package/dist/docs/interfaces/IBooleanField.html +18 -18
  112. package/dist/docs/interfaces/ICommonField.html +18 -18
  113. package/dist/docs/interfaces/ICommonPermissionOwnerFields.html +11 -11
  114. package/dist/docs/interfaces/ICountInfo.html +2 -2
  115. package/dist/docs/interfaces/IDataObject.html +10 -10
  116. package/dist/docs/interfaces/IDataObjectCountQueryParameters.html +10 -10
  117. package/dist/docs/interfaces/IDataObjectDateChangeQueryParameters.html +3 -3
  118. package/dist/docs/interfaces/IDataObjectDateIntervalQueryParameters.html +3 -3
  119. package/dist/docs/interfaces/IDataObjectDescription.html +13 -13
  120. package/dist/docs/interfaces/IDataObjectImagePart.html +3 -0
  121. package/dist/docs/interfaces/IDataObjectLinkQueryParameters.html +4 -4
  122. package/dist/docs/interfaces/IDataObjectQueryParameters.html +16 -16
  123. package/dist/docs/interfaces/IDataObjectSchema.html +3 -3
  124. package/dist/docs/interfaces/IDataObjectSchemaPart.html +2 -2
  125. package/dist/docs/interfaces/IDataObjectTransferable.html +2 -2
  126. package/dist/docs/interfaces/IDataObjectTypeIconPart.html +2 -0
  127. package/dist/docs/interfaces/IDataObjectTypesQueryParameter.html +2 -2
  128. package/dist/docs/interfaces/IDateTimeField.html +20 -20
  129. package/dist/docs/interfaces/IDecimalField.html +21 -21
  130. package/dist/docs/interfaces/IDecimalSuggestField.html +23 -23
  131. package/dist/docs/interfaces/IDocumentService.html +12 -12
  132. package/dist/docs/interfaces/IDomainQueryParameter.html +2 -2
  133. package/dist/docs/interfaces/IDossierEntry.html +4 -4
  134. package/dist/docs/interfaces/IDossierQueryParameters.html +4 -4
  135. package/dist/docs/interfaces/IDoubleField.html +21 -21
  136. package/dist/docs/interfaces/IDoubleSuggestField.html +23 -23
  137. package/dist/docs/interfaces/IEmailStoreService.html +7 -7
  138. package/dist/docs/interfaces/IFavoriteQueryParameter.html +2 -2
  139. package/dist/docs/interfaces/IFetchWrapper.html +4 -3
  140. package/dist/docs/interfaces/IGguidField.html +19 -19
  141. package/dist/docs/interfaces/IGroupInfo.html +6 -6
  142. package/dist/docs/interfaces/IGroupService.html +11 -11
  143. package/dist/docs/interfaces/IGwSpecific.html +2 -2
  144. package/dist/docs/interfaces/IHasFormatOption.html +2 -2
  145. package/dist/docs/interfaces/IHasLength.html +2 -2
  146. package/dist/docs/interfaces/IHasMaxLength.html +2 -2
  147. package/dist/docs/interfaces/IHasOverflowLength.html +2 -2
  148. package/dist/docs/interfaces/IHasPrecision.html +2 -2
  149. package/dist/docs/interfaces/IHasPrecisionAndScale.html +3 -3
  150. package/dist/docs/interfaces/IHasSystemDefinedTranslated.html +2 -2
  151. package/dist/docs/interfaces/IIncludeMaxJournalIdQueryParameter.html +2 -2
  152. package/dist/docs/interfaces/IIncludePermissionsQueryParameter.html +3 -3
  153. package/dist/docs/interfaces/IIncludePrivateForeignrecordsQueryParameter.html +2 -2
  154. package/dist/docs/interfaces/IIntField.html +19 -19
  155. package/dist/docs/interfaces/IIntSuggestField.html +23 -23
  156. package/dist/docs/interfaces/IInterPlatform.html +57 -58
  157. package/dist/docs/interfaces/ILastUsedDataObjectQueryParameters.html +3 -3
  158. package/dist/docs/interfaces/ILinkingService.html +29 -29
  159. package/dist/docs/interfaces/ILoginInformation.html +5 -5
  160. package/dist/docs/interfaces/IMassQueryResult.html +4 -4
  161. package/dist/docs/interfaces/IOpenSpecific.html +2 -2
  162. package/dist/docs/interfaces/IOrderByQueryParameters.html +2 -2
  163. package/dist/docs/interfaces/IPagedQueryParameters.html +3 -3
  164. package/dist/docs/interfaces/IPartialObjectQueryParameters.html +2 -2
  165. package/dist/docs/interfaces/IParticipantInfo.html +4 -4
  166. package/dist/docs/interfaces/IPermission.html +7 -7
  167. package/dist/docs/interfaces/IPermissionInfo.html +4 -4
  168. package/dist/docs/interfaces/IPermissionRequirementQueryParameter.html +2 -2
  169. package/dist/docs/interfaces/IQueryPart.html +2 -2
  170. package/dist/docs/interfaces/IRecentlyUsedQueryParameter.html +2 -2
  171. package/dist/docs/interfaces/IResourceInfo.html +5 -5
  172. package/dist/docs/interfaces/IResourceQueryParameters.html +7 -7
  173. package/dist/docs/interfaces/IResourceService.html +11 -11
  174. package/dist/docs/interfaces/IRestypedBase.html +1 -1
  175. package/dist/docs/interfaces/IRestypedIndexedBase.html +1 -1
  176. package/dist/docs/interfaces/IRestypedRoute.html +5 -5
  177. package/dist/docs/interfaces/ISearchQueryParameters.html +2 -2
  178. package/dist/docs/interfaces/ISelectionValue.html +9 -9
  179. package/dist/docs/interfaces/ISelectionValueListField.html +22 -22
  180. package/dist/docs/interfaces/IServerInformationService.html +4 -4
  181. package/dist/docs/interfaces/IServerSpecificVersionAPIDefinition.html +4 -4
  182. package/dist/docs/interfaces/IServerVersion.html +6 -6
  183. package/dist/docs/interfaces/IServerVersionPart.html +2 -2
  184. package/dist/docs/interfaces/IServerVersionResponseGw.html +2 -2
  185. package/dist/docs/interfaces/IServiceRegistry.html +28 -28
  186. package/dist/docs/interfaces/ISettingsService.html +15 -15
  187. package/dist/docs/interfaces/ISingleDataObjectQueryParameters.html +7 -7
  188. package/dist/docs/interfaces/ISingleDataObjectTypesQueryParameter.html +2 -2
  189. package/dist/docs/interfaces/IStringField.html +20 -20
  190. package/dist/docs/interfaces/IStringKeyed.html +1 -1
  191. package/dist/docs/interfaces/IStringListSuggestField.html +22 -22
  192. package/dist/docs/interfaces/IStringSuggestField.html +22 -22
  193. package/dist/docs/interfaces/ISuggestField.html +20 -20
  194. package/dist/docs/interfaces/ISuggestionWithRawValue.html +3 -3
  195. package/dist/docs/interfaces/ITeamFilter.html +3 -3
  196. package/dist/docs/interfaces/ITeamFilterQueryParameters.html +2 -2
  197. package/dist/docs/interfaces/ITextField.html +22 -22
  198. package/dist/docs/interfaces/ITypedJSONResponse.html +3 -2
  199. package/dist/docs/interfaces/ITypedRequestInit.html +5 -4
  200. package/dist/docs/interfaces/IUserInfo.html +6 -6
  201. package/dist/docs/interfaces/IUserService.html +21 -21
  202. package/dist/docs/interfaces/IVersion6.html +2 -2
  203. package/dist/docs/interfaces/IVersion7.html +2 -2
  204. package/dist/docs/interfaces/IViewInfo.html +3 -3
  205. package/dist/docs/interfaces/IViewItemsCountQueryParameters.html +6 -6
  206. package/dist/docs/interfaces/IViewItemsQueryParameters.html +12 -12
  207. package/dist/docs/interfaces/IViewKindQueryParameters.html +2 -2
  208. package/dist/docs/interfaces/IViewQueryParameters.html +4 -4
  209. package/dist/docs/interfaces/IViewService.html +24 -24
  210. package/dist/docs/interfaces/IWhereStringQueryParameters.html +2 -2
  211. package/dist/docs/interfaces/_internal_.ICommonDataObjectService.html +77 -0
  212. package/dist/docs/interfaces/_internal_.IDataObjectImageService.html +44 -0
  213. package/dist/docs/interfaces/_internal_.IDataObjectTypeIconService.html +11 -0
  214. package/dist/docs/modules/_internal_.html +1 -70
  215. package/dist/docs/modules.html +1 -168
  216. package/dist/docs/types/APIVersion.html +1 -1
  217. package/dist/docs/types/AppSettings.html +1 -1
  218. package/dist/docs/types/AppSettingsChange.html +1 -1
  219. package/dist/docs/types/AppSettingsEndpoint.html +1 -1
  220. package/dist/docs/types/AppSettingsListResponse.html +1 -1
  221. package/dist/docs/types/AppSettingsResponse.html +1 -1
  222. package/dist/docs/types/AppSettingsSchema.html +1 -1
  223. package/dist/docs/types/AppSettingsSchemaBooleanProperty.html +1 -1
  224. package/dist/docs/types/AppSettingsSchemaColorProperty.html +1 -1
  225. package/dist/docs/types/AppSettingsSchemaFloatProperty.html +1 -1
  226. package/dist/docs/types/AppSettingsSchemaIntegerProperty.html +1 -1
  227. package/dist/docs/types/AppSettingsSchemaProperty.html +1 -1
  228. package/dist/docs/types/AppSettingsSchemaPropertyScope.html +1 -1
  229. package/dist/docs/types/AppSettingsSchemaPropertyType.html +1 -1
  230. package/dist/docs/types/AppSettingsSchemaResponse.html +1 -1
  231. package/dist/docs/types/AppSettingsSchemaStringProperty.html +1 -1
  232. package/dist/docs/types/AppSettingsValues.html +1 -1
  233. package/dist/docs/types/FieldCommon.html +1 -1
  234. package/dist/docs/types/FieldCommon7.html +1 -1
  235. package/dist/docs/types/FieldGw.html +1 -1
  236. package/dist/docs/types/FieldGw7.html +1 -1
  237. package/dist/docs/types/FieldOpen.html +1 -1
  238. package/dist/docs/types/FieldType.html +1 -1
  239. package/dist/docs/types/FieldTypes.html +1 -1
  240. package/dist/docs/types/FieldTypesV6.html +1 -1
  241. package/dist/docs/types/FieldTypesV7.html +1 -1
  242. package/dist/docs/types/GUID.html +1 -1
  243. package/dist/docs/types/HasSettingsAPIVersion.html +2 -1
  244. package/dist/docs/types/IAppSettingsSchemaProperty.html +7 -2
  245. package/dist/docs/types/IDataObjectService.html +2 -0
  246. package/dist/docs/types/IHasSelection.html +2 -1
  247. package/dist/docs/types/InterPlatform6.html +1 -1
  248. package/dist/docs/types/InterPlatform6Common.html +1 -1
  249. package/dist/docs/types/InterPlatform6Gw.html +1 -1
  250. package/dist/docs/types/InterPlatform6Open.html +1 -1
  251. package/dist/docs/types/InterPlatform7.html +1 -1
  252. package/dist/docs/types/InterPlatform7Common.html +1 -1
  253. package/dist/docs/types/InterPlatform7Gw.html +1 -1
  254. package/dist/docs/types/InterPlatform7Open.html +1 -1
  255. package/dist/docs/types/InterPlatformGw.html +1 -1
  256. package/dist/docs/types/InterPlatformOpen.html +1 -1
  257. package/dist/docs/types/LinkDirection.html +1 -1
  258. package/dist/docs/types/Methods.html +1 -1
  259. package/dist/docs/types/NoPathParams.html +1 -1
  260. package/dist/docs/types/NoQueryParams.html +1 -1
  261. package/dist/docs/types/OmitProp.html +1 -1
  262. package/dist/docs/types/QueryResponseLegacyGw.html +1 -1
  263. package/dist/docs/types/ServerIndependentFieldTypes.html +1 -1
  264. package/dist/docs/types/ServerType.html +1 -1
  265. package/dist/docs/types/StringKeyOf.html +1 -1
  266. package/dist/docs/types/V7SuggestField.html +1 -1
  267. package/dist/docs/variables/ALL_PUBLIC_PERMISSION_GGUID.html +2 -2
  268. package/npm-third-party-licenses.json +52 -47
  269. package/package.json +6 -6
  270. package/dist/docs/interfaces/IDataObjectService.html +0 -88
@@ -0,0 +1,77 @@
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>ICommonDataObjectService | @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="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="" aria-current="page">ICommonDataObjectService</a></li></ul><h1>Interface ICommonDataObjectService&lt;PLATFORM&gt;</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ICommonDataObjectService</span><span class="tsd-signature-symbol">&lt;</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">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#createobject-1">createObject</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.CreateObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">CreateObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#deleteobject-1">deleteObject</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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_.DeleteObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getobject-1">getObject</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">gguid</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_.GetObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getobjectdescription-1">getObjectDescription</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetObjectDescriptionRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectDescriptionRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getobjectlist-1">getObjectList</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.GetFullObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetFullObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getobjectlistcount-1">getObjectListCount</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetObjectListCountRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectListCountRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getobjectschema-1">getObjectSchema</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.GetObjectSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectSchemaRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getpartialobjectlist-1">getPartialObjectList</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetPartialObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPartialObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getpermissiondetails-1">getPermissionDetails</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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">permissionGguid</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_.GetPermissionDetailsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionDetailsRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getpermissioninfo-1">getPermissionInfo</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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_.GetPermissionInfoRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionInfoRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getpermissioninfocount-1">getPermissionInfoCount</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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_.GetPermissionInfoCountRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionInfoCountRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getrecentlyusedobjectlist-1">getRecentlyUsedObjectList</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetRecentlyUsedObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecentlyUsedObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#maskasrecentlyuseddataobject-1">maskAsRecentlyUsedDataObject</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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_.MaskAsRecentlyUsedDataObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">MaskAsRecentlyUsedDataObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#query-1">query</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</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_.QueryRequestBuilder.html" class="tsd-signature-type tsd-kind-class">QueryRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#saveandreturnobject-1">saveAndReturnObject</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">dataObject</span><span class="tsd-signature-symbol">:</span> <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.PutObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#saveobject-1">saveObject</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">dataObject</span><span class="tsd-signature-symbol">:</span> <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.PutObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</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:1399</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="#createobject" 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>create<wbr/>Object</span></a>
2
+ <a href="#deleteobject" 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>delete<wbr/>Object</span></a>
3
+ <a href="#getobject" 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/>Object</span></a>
4
+ <a href="#getobjectdescription" 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/>Object<wbr/>Description</span></a>
5
+ <a href="#getobjectlist" 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/>Object<wbr/>List</span></a>
6
+ <a href="#getobjectlistcount" 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/>Object<wbr/>List<wbr/>Count</span></a>
7
+ <a href="#getobjectschema" 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/>Object<wbr/>Schema</span></a>
8
+ <a href="#getpartialobjectlist" 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/>Partial<wbr/>Object<wbr/>List</span></a>
9
+ <a href="#getpermissiondetails" 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/>Permission<wbr/>Details</span></a>
10
+ <a href="#getpermissioninfo" 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/>Permission<wbr/>Info</span></a>
11
+ <a href="#getpermissioninfocount" 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/>Permission<wbr/>Info<wbr/>Count</span></a>
12
+ <a href="#getrecentlyusedobjectlist" 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/>Recently<wbr/>Used<wbr/>Object<wbr/>List</span></a>
13
+ <a href="#maskasrecentlyuseddataobject" 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>mask<wbr/>As<wbr/>Recently<wbr/>Used<wbr/>Data<wbr/>Object</span></a>
14
+ <a href="#query" 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>query</span></a>
15
+ <a href="#saveandreturnobject" 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>save<wbr/>And<wbr/>Return<wbr/>Object</span></a>
16
+ <a href="#saveobject" 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>save<wbr/>Object</span></a>
17
+ </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="createobject"><span>create<wbr/>Object</span><a href="#createobject" 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="createobject-1"><span class="tsd-kind-call-signature">createObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.CreateObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">CreateObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#createobject-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>Creates a builder which can be used to create a new record.</p>
18
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record to be created e.g. ADDRESS</p>
19
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.CreateObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">CreateObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1450</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteobject"><span>delete<wbr/>Object</span><a href="#deleteobject" 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="deleteobject-1"><span class="tsd-kind-call-signature">deleteObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">gguid</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_.DeleteObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleteobject-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>Creates a builder which can be used to delete a given record</p>
20
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record to be deleted e.g. ADDRESS</p>
21
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>unique identifier of the record to be deleted</p>
22
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.DeleteObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1405</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getobject"><span>get<wbr/>Object</span><a href="#getobject" 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="getobject-1"><span class="tsd-kind-call-signature">getObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">gguid</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_.GetObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getobject-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>Creates a builder which can be used to retrieve a given record</p>
23
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record to be retrieved e.g. ADDRESS</p>
24
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>unique identifier of the record to be retrieved</p>
25
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1411</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getobjectdescription"><span>get<wbr/>Object<wbr/>Description</span><a href="#getobjectdescription" 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="getobjectdescription-1"><span class="tsd-kind-call-signature">getObjectDescription</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.GetObjectDescriptionRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectDescriptionRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getobjectdescription-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>Creates a builder which can be used to retrieve meta information for
26
+ the given type. This contains information like translations, link
27
+ attributes, flags which indicate whether the type is user sensitive,
28
+ linkable and more.</p>
29
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record type e.g. ADDRESS</p>
30
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetObjectDescriptionRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectDescriptionRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1486</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getobjectlist"><span>get<wbr/>Object<wbr/>List</span><a href="#getobjectlist" 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="getobjectlist-1"><span class="tsd-kind-call-signature">getObjectList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.GetFullObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetFullObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getobjectlist-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>Creates a builder which can be used to retrieve a list of records</p>
31
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record to be retrieved e.g. ADDRESS</p>
32
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetFullObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetFullObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1416</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getobjectlistcount"><span>get<wbr/>Object<wbr/>List<wbr/>Count</span><a href="#getobjectlistcount" 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="getobjectlistcount-1"><span class="tsd-kind-call-signature">getObjectListCount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.GetObjectListCountRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectListCountRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getobjectlistcount-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>Creates a builder which can be used to retrieve the amount of records
33
+ for the given type.</p>
34
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the records to operate on e.g. ADDRESS</p>
35
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetObjectListCountRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectListCountRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1430</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getobjectschema"><span>get<wbr/>Object<wbr/>Schema</span><a href="#getobjectschema" 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="getobjectschema-1"><span class="tsd-kind-call-signature">getObjectSchema</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.GetObjectSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectSchemaRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getobjectschema-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>Creates a builder which can be used to retrieve schema information for
36
+ the given type. The schema contains detailed information about the record
37
+ type e.g. all available fields and their types.</p>
38
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record type e.g. ADDRESS</p>
39
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetObjectSchemaRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetObjectSchemaRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1479</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getpartialobjectlist"><span>get<wbr/>Partial<wbr/>Object<wbr/>List</span><a href="#getpartialobjectlist" 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="getpartialobjectlist-1"><span class="tsd-kind-call-signature">getPartialObjectList</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">type</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_.GetPartialObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPartialObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getpartialobjectlist-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>Creates a builder which can be used to retrieve a list of records
40
+ Please note that the result contains only a fraction of the available
41
+ information. It can be used to access data in an efficient way with
42
+ less network traffic.</p>
43
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the records to be retrieved e.g. ADDRESS</p>
44
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetPartialObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPartialObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1424</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getpermissiondetails"><span>get<wbr/>Permission<wbr/>Details</span><a href="#getpermissiondetails" 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="getpermissiondetails-1"><span class="tsd-kind-call-signature">getPermissionDetails</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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">permissionGguid</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_.GetPermissionDetailsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionDetailsRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getpermissiondetails-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>Creates a builder which can be used to retrieve the detailed permission
45
+ information for the given record and permission.</p>
46
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record e.g. ADDRESS</p>
47
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
48
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">permissionGguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the permission</p>
49
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetPermissionDetailsRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionDetailsRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1472</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getpermissioninfo"><span>get<wbr/>Permission<wbr/>Info</span><a href="#getpermissioninfo" 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="getpermissioninfo-1"><span class="tsd-kind-call-signature">getPermissionInfo</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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_.GetPermissionInfoRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionInfoRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getpermissioninfo-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>Creates a builder which can be used to retrieve the list of permisisons
50
+ for the given object.</p>
51
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record e.g. ADDRESS</p>
52
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
53
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetPermissionInfoRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionInfoRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1457</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getpermissioninfocount"><span>get<wbr/>Permission<wbr/>Info<wbr/>Count</span><a href="#getpermissioninfocount" 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="getpermissioninfocount-1"><span class="tsd-kind-call-signature">getPermissionInfoCount</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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_.GetPermissionInfoCountRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionInfoCountRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getpermissioninfocount-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>Creates a builder which can be used to retrieve the amount of permisisons
54
+ for the given object.</p>
55
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record e.g. ADDRESS</p>
56
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
57
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetPermissionInfoCountRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetPermissionInfoCountRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1464</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrecentlyusedobjectlist"><span>get<wbr/>Recently<wbr/>Used<wbr/>Object<wbr/>List</span><a href="#getrecentlyusedobjectlist" 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="getrecentlyusedobjectlist-1"><span class="tsd-kind-call-signature">getRecentlyUsedObjectList</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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_.GetRecentlyUsedObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecentlyUsedObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getrecentlyusedobjectlist-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>Creates a builder which can be used to retrieve a list of recently
58
+ used records.</p>
59
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of the record to be retrieved e.g. ADDRESS</p>
60
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetRecentlyUsedObjectListRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecentlyUsedObjectListRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1499</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="maskasrecentlyuseddataobject"><span>mask<wbr/>As<wbr/>Recently<wbr/>Used<wbr/>Data<wbr/>Object</span><a href="#maskasrecentlyuseddataobject" 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="maskasrecentlyuseddataobject-1"><span class="tsd-kind-call-signature">maskAsRecentlyUsedDataObject</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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_.MaskAsRecentlyUsedDataObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">MaskAsRecentlyUsedDataObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#maskasrecentlyuseddataobject-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>Creates a builder which can be used to mask the given record
61
+ as recently used.</p>
62
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record type e.g. ADDRESS</p>
63
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
64
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.MaskAsRecentlyUsedDataObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">MaskAsRecentlyUsedDataObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1506</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="query"><span>query</span><a href="#query" 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="query-1"><span class="tsd-kind-call-signature">query</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">query</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_.QueryRequestBuilder.html" class="tsd-signature-type tsd-kind-class">QueryRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#query-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>Creates a builder which can be used to retrieve the result of the given
65
+ query.
66
+ Please note that the query syntax is limited to the Select operation.</p>
67
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the query to be executed</p>
68
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.QueryRequestBuilder.html" class="tsd-signature-type tsd-kind-class">QueryRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1493</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="saveandreturnobject"><span>save<wbr/>And<wbr/>Return<wbr/>Object</span><a href="#saveandreturnobject" 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="saveandreturnobject-1"><span class="tsd-kind-call-signature">saveAndReturnObject</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">dataObject</span><span class="tsd-signature-symbol">:</span> <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.PutObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a><span class="tsd-signature-symbol">&gt;</span><a href="#saveandreturnobject-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>Creates a builder which can be used to save and then retrieve
69
+ a given record.
70
+ Please note that during the saving process the object is going
71
+ to be normalized to match the contract given by the API.</p>
72
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataObject</span>: <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a></span><div class="tsd-comment tsd-typography"><p>the record to be saved</p>
73
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.PutObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1445</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="saveobject"><span>save<wbr/>Object</span><a href="#saveobject" 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="saveobject-1"><span class="tsd-kind-call-signature">saveObject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">dataObject</span><span class="tsd-signature-symbol">:</span> <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="../classes/_internal_.PutObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#saveobject-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>Creates a builder which can be used to save a given record.
74
+ Please note that during the saving process the object is going
75
+ to be normalized to match the contract given by the API.</p>
76
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataObject</span>: <a href="IDataObject.html" class="tsd-signature-type tsd-kind-interface">IDataObject</a></span><div class="tsd-comment tsd-typography"><p>the record to be saved</p>
77
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.PutObjectRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutObjectRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1437</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="#createobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Object</span></a><a href="#deleteobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Object</span></a><a href="#getobject"><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/>Object</span></a><a href="#getobjectdescription"><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/>Object<wbr/>Description</span></a><a href="#getobjectlist"><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/>Object<wbr/>List</span></a><a href="#getobjectlistcount"><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/>Object<wbr/>List<wbr/>Count</span></a><a href="#getobjectschema"><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/>Object<wbr/>Schema</span></a><a href="#getpartialobjectlist"><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/>Partial<wbr/>Object<wbr/>List</span></a><a href="#getpermissiondetails"><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/>Permission<wbr/>Details</span></a><a href="#getpermissioninfo"><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/>Permission<wbr/>Info</span></a><a href="#getpermissioninfocount"><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/>Permission<wbr/>Info<wbr/>Count</span></a><a href="#getrecentlyusedobjectlist"><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/>Recently<wbr/>Used<wbr/>Object<wbr/>List</span></a><a href="#maskasrecentlyuseddataobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mask<wbr/>As<wbr/>Recently<wbr/>Used<wbr/>Data<wbr/>Object</span></a><a href="#query"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>query</span></a><a href="#saveandreturnobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>And<wbr/>Return<wbr/>Object</span></a><a href="#saveobject"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>save<wbr/>Object</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>
@@ -0,0 +1,44 @@
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>IDataObjectImageService | @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="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="" aria-current="page">IDataObjectImageService</a></li></ul><h1>Interface IDataObjectImageService&lt;PLATFORM&gt;</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IDataObjectImageService</span><span class="tsd-signature-symbol">&lt;</span><br/>    <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">&amp;</span> <a href="IDataObjectImagePart.html" class="tsd-signature-type tsd-kind-interface">IDataObjectImagePart</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#deletedefaultrecordimage-1">deleteDefaultRecordImage</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.DeleteDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#deleterecordimage-1">deleteRecordImage</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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_.DeleteRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getdefaultrecordimage-1">getDefaultRecordImage</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getdefaultrecordimageasblob-1">getDefaultRecordImageAsBlob</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetDefaultRecordImageAsBlobRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetDefaultRecordImageAsBlobRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getrecordimage-1">getRecordImage</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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_.GetRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getrecordimageasblob-1">getRecordImageAsBlob</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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_.GetRecordImageAsBlobRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordImageAsBlobRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#updatedefaultrecordimage-1">updateDefaultRecordImage</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">fileExtension</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_.PutDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#updaterecordimage-1">updateRecordImage</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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">gguid</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">eTagOfRecord</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">fileExtension</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_.PutRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</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 class="tsd-signature-symbol">&amp;</span> <a href="IDataObjectImagePart.html" class="tsd-signature-type tsd-kind-interface">IDataObjectImagePart</a></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1508</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="#deletedefaultrecordimage" 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>delete<wbr/>Default<wbr/>Record<wbr/>Image</span></a>
2
+ <a href="#deleterecordimage" 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>delete<wbr/>Record<wbr/>Image</span></a>
3
+ <a href="#getdefaultrecordimage" 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/>Default<wbr/>Record<wbr/>Image</span></a>
4
+ <a href="#getdefaultrecordimageasblob" 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/>Default<wbr/>Record<wbr/>Image<wbr/>As<wbr/>Blob</span></a>
5
+ <a href="#getrecordimage" 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/>Record<wbr/>Image</span></a>
6
+ <a href="#getrecordimageasblob" 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/>Record<wbr/>Image<wbr/>As<wbr/>Blob</span></a>
7
+ <a href="#updatedefaultrecordimage" 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>update<wbr/>Default<wbr/>Record<wbr/>Image</span></a>
8
+ <a href="#updaterecordimage" 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>update<wbr/>Record<wbr/>Image</span></a>
9
+ </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="deletedefaultrecordimage"><span>delete<wbr/>Default<wbr/>Record<wbr/>Image</span><a href="#deletedefaultrecordimage" 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="deletedefaultrecordimage-1"><span class="tsd-kind-call-signature">deleteDefaultRecordImage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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_.DeleteDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#deletedefaultrecordimage-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>Creates a builder which can be used to delete the image associated with the record type.</p>
10
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
11
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.DeleteDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1536</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleterecordimage"><span>delete<wbr/>Record<wbr/>Image</span><a href="#deleterecordimage" 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="deleterecordimage-1"><span class="tsd-kind-call-signature">deleteRecordImage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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_.DeleteRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#deleterecordimage-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>Creates a builder which can be used to delete the image associated with the given record.</p>
12
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
13
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
14
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.DeleteRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">DeleteRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1571</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdefaultrecordimage"><span>get<wbr/>Default<wbr/>Record<wbr/>Image</span><a href="#getdefaultrecordimage" 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="getdefaultrecordimage-1"><span class="tsd-kind-call-signature">getDefaultRecordImage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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_.GetDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getdefaultrecordimage-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>Creates a builder which can be used to retrieve the default image associated with the record type.
15
+ Please note that the returned image is an ArrayBuffer in this case.
16
+ To display the image it might be more appropriate to use
17
+ [[IDataObjectService.getRecordImageAsBlob]]</p>
18
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
19
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1517</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getdefaultrecordimageasblob"><span>get<wbr/>Default<wbr/>Record<wbr/>Image<wbr/>As<wbr/>Blob</span><a href="#getdefaultrecordimageasblob" 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="getdefaultrecordimageasblob-1"><span class="tsd-kind-call-signature">getDefaultRecordImageAsBlob</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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_.GetDefaultRecordImageAsBlobRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetDefaultRecordImageAsBlobRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getdefaultrecordimageasblob-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>Creates a builder which can be used to retrieve the image associated with the record type
20
+ as a [[Blob]]. This can then be used to create a URL which can be used as e.g.
21
+ the src attribute of an img element.</p>
22
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
23
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetDefaultRecordImageAsBlobRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetDefaultRecordImageAsBlobRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1525</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrecordimage"><span>get<wbr/>Record<wbr/>Image</span><a href="#getrecordimage" 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="getrecordimage-1"><span class="tsd-kind-call-signature">getRecordImage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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_.GetRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getrecordimage-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>Creates a builder which can be used to retrieve the image associated with the record.
24
+ Please note that the returned image is an ArrayBuffer in this case.
25
+ To display the image it might be more appropriate to use
26
+ [[IDataObjectService.getRecordImageAsBlob]]</p>
27
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
28
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
29
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1546</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrecordimageasblob"><span>get<wbr/>Record<wbr/>Image<wbr/>As<wbr/>Blob</span><a href="#getrecordimageasblob" 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="getrecordimageasblob-1"><span class="tsd-kind-call-signature">getRecordImageAsBlob</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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_.GetRecordImageAsBlobRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordImageAsBlobRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#getrecordimageasblob-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>Creates a builder which can be used to retrieve the image associated with the record
30
+ as a [[Blob]]. This can then be used to create a URL which can be used as e.g.
31
+ the src attribute of an img element.</p>
32
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
33
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
34
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetRecordImageAsBlobRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordImageAsBlobRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1555</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updatedefaultrecordimage"><span>update<wbr/>Default<wbr/>Record<wbr/>Image</span><a href="#updatedefaultrecordimage" 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="updatedefaultrecordimage-1"><span class="tsd-kind-call-signature">updateDefaultRecordImage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">fileExtension</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_.PutDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#updatedefaultrecordimage-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>Creates a builder which can be used to update the image associated with the record type.</p>
35
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
36
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileExtension</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the file extension for the uploaded content</p>
37
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.PutDefaultRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutDefaultRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1531</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updaterecordimage"><span>update<wbr/>Record<wbr/>Image</span><a href="#updaterecordimage" 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="updaterecordimage-1"><span class="tsd-kind-call-signature">updateRecordImage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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">gguid</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">eTagOfRecord</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">fileExtension</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_.PutRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span><a href="#updaterecordimage-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>Creates a builder which can be used to update the image associated with the given record.</p>
38
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record e.g. ADDRESS</p>
39
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">gguid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>gguid of the record</p>
40
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">eTagOfRecord</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the ETAG field of the record, please note that
41
+ it is used to guarantee update safety. It can be aquired from a previously
42
+ fetched record.</p>
43
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileExtension</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the file extension for the uploaded content</p>
44
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.PutRecordImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">PutRecordImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1565</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="#deletedefaultrecordimage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Default<wbr/>Record<wbr/>Image</span></a><a href="#deleterecordimage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Record<wbr/>Image</span></a><a href="#getdefaultrecordimage"><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/>Default<wbr/>Record<wbr/>Image</span></a><a href="#getdefaultrecordimageasblob"><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/>Default<wbr/>Record<wbr/>Image<wbr/>As<wbr/>Blob</span></a><a href="#getrecordimage"><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/>Record<wbr/>Image</span></a><a href="#getrecordimageasblob"><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/>Record<wbr/>Image<wbr/>As<wbr/>Blob</span></a><a href="#updatedefaultrecordimage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Default<wbr/>Record<wbr/>Image</span></a><a href="#updaterecordimage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Record<wbr/>Image</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>
@@ -0,0 +1,11 @@
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>IDataObjectTypeIconService | @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="../modules/_internal_.html">&lt;internal&gt;</a></li><li><a href="" aria-current="page">IDataObjectTypeIconService</a></li></ul><h1>Interface IDataObjectTypeIconService&lt;PLATFORM&gt;</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">IDataObjectTypeIconService</span><span class="tsd-signature-symbol">&lt;</span><br/>    <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">&amp;</span> <a href="IDataObjectTypeIconPart.html" class="tsd-signature-type tsd-kind-interface">IDataObjectTypeIconPart</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-call-signature" href="#getrecordtypeimage-1">getRecordTypeImage</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetRecordTypeImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordTypeImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="#getrecordtypeimageblob-1">getRecordTypeImageBlob</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">type</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_.GetRecordTypeImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordTypeImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">&gt;</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 class="tsd-signature-symbol">&amp;</span> <a href="IDataObjectTypeIconPart.html" class="tsd-signature-type tsd-kind-interface">IDataObjectTypeIconPart</a></span></li></ul></section><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1573</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="#getrecordtypeimage" 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/>Record<wbr/>Type<wbr/>Image</span></a>
2
+ <a href="#getrecordtypeimageblob" 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/>Record<wbr/>Type<wbr/>Image<wbr/>Blob</span></a>
3
+ </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="getrecordtypeimage"><span>get<wbr/>Record<wbr/>Type<wbr/>Image</span><a href="#getrecordtypeimage" 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="getrecordtypeimage-1"><span class="tsd-kind-call-signature">getRecordTypeImage</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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_.GetRecordTypeImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordTypeImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span><a href="#getrecordtypeimage-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>Creates a builder which can be used to retrieve the image
4
+ for a given record type.</p>
5
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record type e.g. ADDRESS</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetRecordTypeImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordTypeImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">ArrayBuffer</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1579</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getrecordtypeimageblob"><span>get<wbr/>Record<wbr/>Type<wbr/>Image<wbr/>Blob</span><a href="#getrecordtypeimageblob" 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="getrecordtypeimageblob-1"><span class="tsd-kind-call-signature">getRecordTypeImageBlob</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">type</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_.GetRecordTypeImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordTypeImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">&gt;</span><a href="#getrecordtypeimageblob-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>Creates a builder which can be used to retrieve the image
7
+ for a given record type.
8
+ This can then be used to create a URL which can be used as e.g.
9
+ the src attribute of an img element.</p>
10
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>record type e.g. ADDRESS</p>
11
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="../classes/_internal_.GetRecordTypeImageRequestBuilder.html" class="tsd-signature-type tsd-kind-class">GetRecordTypeImageRequestBuilder</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#platform">PLATFORM</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">Blob</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in dataaccess/dist/dataaccess.d.ts:1587</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="#getrecordtypeimage"><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/>Record<wbr/>Type<wbr/>Image</span></a><a href="#getrecordtypeimageblob"><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/>Record<wbr/>Type<wbr/>Image<wbr/>Blob</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>