@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.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 (577) hide show
  1. package/data/help/index.json +9685 -0
  2. package/data/script-api/index.json +1 -528
  3. package/data/tooling/index.json +4 -4
  4. package/data/xsd/index.json +1 -1
  5. package/dist/esm/cli/base-command.js +5 -0
  6. package/dist/esm/cli/base-command.js.map +1 -1
  7. package/dist/esm/clients/index.d.ts +2 -0
  8. package/dist/esm/clients/index.js +1 -0
  9. package/dist/esm/clients/index.js.map +1 -1
  10. package/dist/esm/clients/middleware-registry.d.ts +1 -1
  11. package/dist/esm/clients/middleware-registry.js.map +1 -1
  12. package/dist/esm/clients/preferences.d.ts +83 -0
  13. package/dist/esm/clients/preferences.generated.d.ts +1651 -0
  14. package/dist/esm/clients/preferences.generated.js +6 -0
  15. package/dist/esm/clients/preferences.generated.js.map +1 -0
  16. package/dist/esm/clients/preferences.js +64 -0
  17. package/dist/esm/clients/preferences.js.map +1 -0
  18. package/dist/esm/config/dw-json.d.ts +2 -0
  19. package/dist/esm/config/dw-json.js.map +1 -1
  20. package/dist/esm/config/mapping.js +4 -0
  21. package/dist/esm/config/mapping.js.map +1 -1
  22. package/dist/esm/config/sources/dw-json-source.js +17 -4
  23. package/dist/esm/config/sources/dw-json-source.js.map +1 -1
  24. package/dist/esm/config/sources/env-source.js +2 -0
  25. package/dist/esm/config/sources/env-source.js.map +1 -1
  26. package/dist/esm/config/types.d.ts +14 -0
  27. package/dist/esm/docs/content-cache.d.ts +70 -0
  28. package/dist/esm/docs/content-cache.js +186 -0
  29. package/dist/esm/docs/content-cache.js.map +1 -0
  30. package/dist/esm/docs/index.d.ts +1 -0
  31. package/dist/esm/docs/index.js +2 -0
  32. package/dist/esm/docs/index.js.map +1 -1
  33. package/dist/esm/docs/search.js +34 -6
  34. package/dist/esm/docs/search.js.map +1 -1
  35. package/dist/esm/docs/types.d.ts +6 -1
  36. package/dist/esm/docs/types.js +1 -0
  37. package/dist/esm/docs/types.js.map +1 -1
  38. package/dist/esm/index.d.ts +2 -2
  39. package/dist/esm/index.js +1 -1
  40. package/dist/esm/index.js.map +1 -1
  41. package/dist/esm/operations/jobs/discover.d.ts +46 -0
  42. package/dist/esm/operations/jobs/discover.js +87 -0
  43. package/dist/esm/operations/jobs/discover.js.map +1 -0
  44. package/dist/esm/operations/jobs/index.d.ts +2 -0
  45. package/dist/esm/operations/jobs/index.js +2 -0
  46. package/dist/esm/operations/jobs/index.js.map +1 -1
  47. package/dist/esm/operations/jobs/run.js +4 -3
  48. package/dist/esm/operations/jobs/run.js.map +1 -1
  49. package/package.json +5 -3
  50. package/specs/preferences-v1.yaml +2095 -0
  51. package/data/script-api/TopLevel.APIException.md +0 -119
  52. package/data/script-api/TopLevel.Array.md +0 -732
  53. package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
  54. package/data/script-api/TopLevel.BigInt.md +0 -154
  55. package/data/script-api/TopLevel.Boolean.md +0 -83
  56. package/data/script-api/TopLevel.ConversionError.md +0 -51
  57. package/data/script-api/TopLevel.DataView.md +0 -271
  58. package/data/script-api/TopLevel.Date.md +0 -688
  59. package/data/script-api/TopLevel.ES6Iterator.md +0 -47
  60. package/data/script-api/TopLevel.Error.md +0 -124
  61. package/data/script-api/TopLevel.EvalError.md +0 -47
  62. package/data/script-api/TopLevel.Fault.md +0 -133
  63. package/data/script-api/TopLevel.Float32Array.md +0 -186
  64. package/data/script-api/TopLevel.Float64Array.md +0 -186
  65. package/data/script-api/TopLevel.Function.md +0 -114
  66. package/data/script-api/TopLevel.Generator.md +0 -132
  67. package/data/script-api/TopLevel.IOError.md +0 -98
  68. package/data/script-api/TopLevel.Int16Array.md +0 -186
  69. package/data/script-api/TopLevel.Int32Array.md +0 -186
  70. package/data/script-api/TopLevel.Int8Array.md +0 -186
  71. package/data/script-api/TopLevel.InternalError.md +0 -47
  72. package/data/script-api/TopLevel.Iterable.md +0 -44
  73. package/data/script-api/TopLevel.Iterator.md +0 -89
  74. package/data/script-api/TopLevel.JSON.md +0 -173
  75. package/data/script-api/TopLevel.Map.md +0 -189
  76. package/data/script-api/TopLevel.Math.md +0 -948
  77. package/data/script-api/TopLevel.Module.md +0 -152
  78. package/data/script-api/TopLevel.Namespace.md +0 -152
  79. package/data/script-api/TopLevel.Number.md +0 -404
  80. package/data/script-api/TopLevel.Object.md +0 -472
  81. package/data/script-api/TopLevel.QName.md +0 -147
  82. package/data/script-api/TopLevel.RangeError.md +0 -47
  83. package/data/script-api/TopLevel.ReferenceError.md +0 -47
  84. package/data/script-api/TopLevel.RegExp.md +0 -155
  85. package/data/script-api/TopLevel.Set.md +0 -150
  86. package/data/script-api/TopLevel.StopIteration.md +0 -36
  87. package/data/script-api/TopLevel.String.md +0 -1060
  88. package/data/script-api/TopLevel.Symbol.md +0 -196
  89. package/data/script-api/TopLevel.SyntaxError.md +0 -47
  90. package/data/script-api/TopLevel.SystemError.md +0 -99
  91. package/data/script-api/TopLevel.TypeError.md +0 -47
  92. package/data/script-api/TopLevel.URIError.md +0 -47
  93. package/data/script-api/TopLevel.Uint16Array.md +0 -186
  94. package/data/script-api/TopLevel.Uint32Array.md +0 -186
  95. package/data/script-api/TopLevel.Uint8Array.md +0 -186
  96. package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
  97. package/data/script-api/TopLevel.WeakMap.md +0 -135
  98. package/data/script-api/TopLevel.WeakSet.md +0 -96
  99. package/data/script-api/TopLevel.XML.md +0 -922
  100. package/data/script-api/TopLevel.XMLList.md +0 -418
  101. package/data/script-api/TopLevel.XMLStreamError.md +0 -115
  102. package/data/script-api/TopLevel.arguments.md +0 -56
  103. package/data/script-api/TopLevel.global.md +0 -539
  104. package/data/script-api/TopLevel.md +0 -58
  105. package/data/script-api/dw.alert.Alert.md +0 -175
  106. package/data/script-api/dw.alert.Alerts.md +0 -256
  107. package/data/script-api/dw.alert.md +0 -7
  108. package/data/script-api/dw.campaign.ABTest.md +0 -63
  109. package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
  110. package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
  111. package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
  112. package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
  113. package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
  114. package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
  115. package/data/script-api/dw.campaign.Campaign.md +0 -346
  116. package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
  117. package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
  118. package/data/script-api/dw.campaign.Coupon.md +0 -324
  119. package/data/script-api/dw.campaign.CouponMgr.md +0 -137
  120. package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
  121. package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
  122. package/data/script-api/dw.campaign.Discount.md +0 -271
  123. package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
  124. package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
  125. package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
  126. package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
  127. package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
  128. package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
  129. package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
  130. package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
  131. package/data/script-api/dw.campaign.Promotion.md +0 -939
  132. package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
  133. package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
  134. package/data/script-api/dw.campaign.SlotContent.md +0 -131
  135. package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
  136. package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
  137. package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
  138. package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
  139. package/data/script-api/dw.campaign.md +0 -36
  140. package/data/script-api/dw.catalog.Catalog.md +0 -158
  141. package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
  142. package/data/script-api/dw.catalog.Category.md +0 -1212
  143. package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
  144. package/data/script-api/dw.catalog.CategoryLink.md +0 -142
  145. package/data/script-api/dw.catalog.PriceBook.md +0 -215
  146. package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
  147. package/data/script-api/dw.catalog.Product.md +0 -2492
  148. package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
  149. package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
  150. package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
  151. package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
  152. package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
  153. package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
  154. package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
  155. package/data/script-api/dw.catalog.ProductLink.md +0 -166
  156. package/data/script-api/dw.catalog.ProductMgr.md +0 -136
  157. package/data/script-api/dw.catalog.ProductOption.md +0 -189
  158. package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
  159. package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
  160. package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
  161. package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
  162. package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
  163. package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
  164. package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
  165. package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
  166. package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
  167. package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
  168. package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
  169. package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
  170. package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
  171. package/data/script-api/dw.catalog.Recommendation.md +0 -327
  172. package/data/script-api/dw.catalog.SearchModel.md +0 -769
  173. package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
  174. package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
  175. package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
  176. package/data/script-api/dw.catalog.SortingOption.md +0 -120
  177. package/data/script-api/dw.catalog.SortingRule.md +0 -53
  178. package/data/script-api/dw.catalog.Store.md +0 -484
  179. package/data/script-api/dw.catalog.StoreGroup.md +0 -95
  180. package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
  181. package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
  182. package/data/script-api/dw.catalog.StoreMgr.md +0 -223
  183. package/data/script-api/dw.catalog.Variant.md +0 -1000
  184. package/data/script-api/dw.catalog.VariationGroup.md +0 -869
  185. package/data/script-api/dw.catalog.md +0 -50
  186. package/data/script-api/dw.content.Content.md +0 -481
  187. package/data/script-api/dw.content.ContentMgr.md +0 -147
  188. package/data/script-api/dw.content.ContentSearchModel.md +0 -618
  189. package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
  190. package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
  191. package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
  192. package/data/script-api/dw.content.Folder.md +0 -432
  193. package/data/script-api/dw.content.Library.md +0 -124
  194. package/data/script-api/dw.content.MarkupText.md +0 -150
  195. package/data/script-api/dw.content.MediaFile.md +0 -367
  196. package/data/script-api/dw.content.md +0 -15
  197. package/data/script-api/dw.crypto.CertificateRef.md +0 -59
  198. package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
  199. package/data/script-api/dw.crypto.Cipher.md +0 -1234
  200. package/data/script-api/dw.crypto.Encoding.md +0 -193
  201. package/data/script-api/dw.crypto.JWE.md +0 -245
  202. package/data/script-api/dw.crypto.JWEHeader.md +0 -147
  203. package/data/script-api/dw.crypto.JWS.md +0 -260
  204. package/data/script-api/dw.crypto.JWSHeader.md +0 -128
  205. package/data/script-api/dw.crypto.KeyRef.md +0 -77
  206. package/data/script-api/dw.crypto.Mac.md +0 -191
  207. package/data/script-api/dw.crypto.MessageDigest.md +0 -243
  208. package/data/script-api/dw.crypto.SecureRandom.md +0 -161
  209. package/data/script-api/dw.crypto.Signature.md +0 -241
  210. package/data/script-api/dw.crypto.WeakCipher.md +0 -725
  211. package/data/script-api/dw.crypto.WeakMac.md +0 -163
  212. package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
  213. package/data/script-api/dw.crypto.WeakSignature.md +0 -208
  214. package/data/script-api/dw.crypto.X509Certificate.md +0 -180
  215. package/data/script-api/dw.crypto.md +0 -23
  216. package/data/script-api/dw.customer.AddressBook.md +0 -158
  217. package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
  218. package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
  219. package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
  220. package/data/script-api/dw.customer.Credentials.md +0 -524
  221. package/data/script-api/dw.customer.Customer.md +0 -488
  222. package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
  223. package/data/script-api/dw.customer.CustomerAddress.md +0 -666
  224. package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
  225. package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
  226. package/data/script-api/dw.customer.CustomerGroup.md +0 -146
  227. package/data/script-api/dw.customer.CustomerList.md +0 -76
  228. package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
  229. package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
  230. package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
  231. package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
  232. package/data/script-api/dw.customer.EncryptedObject.md +0 -34
  233. package/data/script-api/dw.customer.ExternalProfile.md +0 -154
  234. package/data/script-api/dw.customer.OrderHistory.md +0 -167
  235. package/data/script-api/dw.customer.ProductList.md +0 -870
  236. package/data/script-api/dw.customer.ProductListItem.md +0 -469
  237. package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
  238. package/data/script-api/dw.customer.ProductListMgr.md +0 -350
  239. package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
  240. package/data/script-api/dw.customer.Profile.md +0 -940
  241. package/data/script-api/dw.customer.Wallet.md +0 -136
  242. package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
  243. package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
  244. package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
  245. package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
  246. package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
  247. package/data/script-api/dw.customer.consent.md +0 -10
  248. package/data/script-api/dw.customer.md +0 -31
  249. package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
  250. package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
  251. package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
  252. package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
  253. package/data/script-api/dw.customer.oauth.md +0 -9
  254. package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
  255. package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
  256. package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
  257. package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
  258. package/data/script-api/dw.customer.shoppercontext.md +0 -9
  259. package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
  260. package/data/script-api/dw.experience.Component.md +0 -166
  261. package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
  262. package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
  263. package/data/script-api/dw.experience.CustomEditor.md +0 -146
  264. package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
  265. package/data/script-api/dw.experience.Page.md +0 -467
  266. package/data/script-api/dw.experience.PageMgr.md +0 -549
  267. package/data/script-api/dw.experience.PageScriptContext.md +0 -200
  268. package/data/script-api/dw.experience.Region.md +0 -119
  269. package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
  270. package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
  271. package/data/script-api/dw.experience.cms.md +0 -6
  272. package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
  273. package/data/script-api/dw.experience.image.Image.md +0 -101
  274. package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
  275. package/data/script-api/dw.experience.image.md +0 -8
  276. package/data/script-api/dw.experience.md +0 -16
  277. package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
  278. package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
  279. package/data/script-api/dw.extensions.applepay.md +0 -7
  280. package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
  281. package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
  282. package/data/script-api/dw.extensions.facebook.md +0 -7
  283. package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
  284. package/data/script-api/dw.extensions.paymentapi.md +0 -6
  285. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
  286. package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
  287. package/data/script-api/dw.extensions.paymentrequest.md +0 -7
  288. package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
  289. package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
  290. package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
  291. package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
  292. package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
  293. package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
  294. package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
  295. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
  296. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
  297. package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
  298. package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
  299. package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
  300. package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
  301. package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
  302. package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
  303. package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
  304. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
  305. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
  306. package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
  307. package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
  308. package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
  309. package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
  310. package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
  311. package/data/script-api/dw.extensions.payments.md +0 -28
  312. package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
  313. package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
  314. package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
  315. package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
  316. package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
  317. package/data/script-api/dw.extensions.pinterest.md +0 -10
  318. package/data/script-api/dw.io.CSVStreamReader.md +0 -128
  319. package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
  320. package/data/script-api/dw.io.File.md +0 -729
  321. package/data/script-api/dw.io.FileReader.md +0 -70
  322. package/data/script-api/dw.io.FileWriter.md +0 -159
  323. package/data/script-api/dw.io.InputStream.md +0 -35
  324. package/data/script-api/dw.io.OutputStream.md +0 -38
  325. package/data/script-api/dw.io.PrintWriter.md +0 -66
  326. package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
  327. package/data/script-api/dw.io.Reader.md +0 -284
  328. package/data/script-api/dw.io.StringWriter.md +0 -89
  329. package/data/script-api/dw.io.Writer.md +0 -96
  330. package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
  331. package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
  332. package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
  333. package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
  334. package/data/script-api/dw.io.md +0 -21
  335. package/data/script-api/dw.job.JobExecution.md +0 -111
  336. package/data/script-api/dw.job.JobStepExecution.md +0 -136
  337. package/data/script-api/dw.job.md +0 -7
  338. package/data/script-api/dw.net.FTPClient.md +0 -621
  339. package/data/script-api/dw.net.FTPFileInfo.md +0 -132
  340. package/data/script-api/dw.net.HTTPClient.md +0 -775
  341. package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
  342. package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
  343. package/data/script-api/dw.net.Mail.md +0 -487
  344. package/data/script-api/dw.net.SFTPClient.md +0 -535
  345. package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
  346. package/data/script-api/dw.net.WebDAVClient.md +0 -762
  347. package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
  348. package/data/script-api/dw.net.md +0 -15
  349. package/data/script-api/dw.object.ActiveData.md +0 -86
  350. package/data/script-api/dw.object.CustomAttributes.md +0 -165
  351. package/data/script-api/dw.object.CustomObject.md +0 -82
  352. package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
  353. package/data/script-api/dw.object.Extensible.md +0 -71
  354. package/data/script-api/dw.object.ExtensibleObject.md +0 -85
  355. package/data/script-api/dw.object.Note.md +0 -118
  356. package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
  357. package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
  358. package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
  359. package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
  360. package/data/script-api/dw.object.PersistentObject.md +0 -92
  361. package/data/script-api/dw.object.SimpleExtensible.md +0 -53
  362. package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
  363. package/data/script-api/dw.object.md +0 -19
  364. package/data/script-api/dw.order.AbstractItem.md +0 -220
  365. package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
  366. package/data/script-api/dw.order.Appeasement.md +0 -398
  367. package/data/script-api/dw.order.AppeasementItem.md +0 -104
  368. package/data/script-api/dw.order.Basket.md +0 -868
  369. package/data/script-api/dw.order.BasketMgr.md +0 -673
  370. package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
  371. package/data/script-api/dw.order.CouponLineItem.md +0 -289
  372. package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
  373. package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
  374. package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
  375. package/data/script-api/dw.order.CreateOrderException.md +0 -23
  376. package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
  377. package/data/script-api/dw.order.GiftCertificate.md +0 -530
  378. package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
  379. package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
  380. package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
  381. package/data/script-api/dw.order.Invoice.md +0 -571
  382. package/data/script-api/dw.order.InvoiceItem.md +0 -199
  383. package/data/script-api/dw.order.LineItem.md +0 -577
  384. package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
  385. package/data/script-api/dw.order.LineItemTax.md +0 -142
  386. package/data/script-api/dw.order.Order.md +0 -2770
  387. package/data/script-api/dw.order.OrderAddress.md +0 -624
  388. package/data/script-api/dw.order.OrderItem.md +0 -613
  389. package/data/script-api/dw.order.OrderMgr.md +0 -1502
  390. package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
  391. package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
  392. package/data/script-api/dw.order.PaymentCard.md +0 -220
  393. package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
  394. package/data/script-api/dw.order.PaymentMethod.md +0 -257
  395. package/data/script-api/dw.order.PaymentMgr.md +0 -138
  396. package/data/script-api/dw.order.PaymentProcessor.md +0 -106
  397. package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
  398. package/data/script-api/dw.order.PaymentTransaction.md +0 -291
  399. package/data/script-api/dw.order.PriceAdjustment.md +0 -745
  400. package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
  401. package/data/script-api/dw.order.ProductLineItem.md +0 -1749
  402. package/data/script-api/dw.order.ProductShippingCost.md +0 -101
  403. package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
  404. package/data/script-api/dw.order.ProductShippingModel.md +0 -143
  405. package/data/script-api/dw.order.Return.md +0 -396
  406. package/data/script-api/dw.order.ReturnCase.md +0 -463
  407. package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
  408. package/data/script-api/dw.order.ReturnItem.md +0 -335
  409. package/data/script-api/dw.order.Shipment.md +0 -1132
  410. package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
  411. package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
  412. package/data/script-api/dw.order.ShippingLineItem.md +0 -315
  413. package/data/script-api/dw.order.ShippingLocation.md +0 -313
  414. package/data/script-api/dw.order.ShippingMethod.md +0 -251
  415. package/data/script-api/dw.order.ShippingMgr.md +0 -173
  416. package/data/script-api/dw.order.ShippingOrder.md +0 -630
  417. package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
  418. package/data/script-api/dw.order.SumItem.md +0 -158
  419. package/data/script-api/dw.order.TaxGroup.md +0 -128
  420. package/data/script-api/dw.order.TaxItem.md +0 -74
  421. package/data/script-api/dw.order.TaxMgr.md +0 -314
  422. package/data/script-api/dw.order.TrackingInfo.md +0 -261
  423. package/data/script-api/dw.order.TrackingRef.md +0 -108
  424. package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
  425. package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
  426. package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
  427. package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
  428. package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
  429. package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
  430. package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
  431. package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
  432. package/data/script-api/dw.order.hooks.md +0 -13
  433. package/data/script-api/dw.order.md +0 -65
  434. package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
  435. package/data/script-api/dw.rpc.Stub.md +0 -373
  436. package/data/script-api/dw.rpc.WebReference.md +0 -133
  437. package/data/script-api/dw.rpc.md +0 -8
  438. package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
  439. package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
  440. package/data/script-api/dw.sitemap.md +0 -7
  441. package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
  442. package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
  443. package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
  444. package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
  445. package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
  446. package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
  447. package/data/script-api/dw.suggest.SuggestModel.md +0 -471
  448. package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
  449. package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
  450. package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
  451. package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
  452. package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
  453. package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
  454. package/data/script-api/dw.suggest.Suggestions.md +0 -206
  455. package/data/script-api/dw.suggest.md +0 -19
  456. package/data/script-api/dw.svc.FTPService.md +0 -140
  457. package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
  458. package/data/script-api/dw.svc.HTTPFormService.md +0 -32
  459. package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
  460. package/data/script-api/dw.svc.HTTPService.md +0 -370
  461. package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
  462. package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
  463. package/data/script-api/dw.svc.Result.md +0 -320
  464. package/data/script-api/dw.svc.SOAPService.md +0 -104
  465. package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
  466. package/data/script-api/dw.svc.Service.md +0 -276
  467. package/data/script-api/dw.svc.ServiceCallback.md +0 -282
  468. package/data/script-api/dw.svc.ServiceConfig.md +0 -114
  469. package/data/script-api/dw.svc.ServiceCredential.md +0 -162
  470. package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
  471. package/data/script-api/dw.svc.ServiceProfile.md +0 -152
  472. package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
  473. package/data/script-api/dw.svc.md +0 -22
  474. package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
  475. package/data/script-api/dw.system.Cache.md +0 -126
  476. package/data/script-api/dw.system.CacheMgr.md +0 -70
  477. package/data/script-api/dw.system.HookMgr.md +0 -78
  478. package/data/script-api/dw.system.InternalObject.md +0 -47
  479. package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
  480. package/data/script-api/dw.system.Log.md +0 -198
  481. package/data/script-api/dw.system.LogNDC.md +0 -75
  482. package/data/script-api/dw.system.Logger.md +0 -216
  483. package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
  484. package/data/script-api/dw.system.Pipeline.md +0 -94
  485. package/data/script-api/dw.system.PipelineDictionary.md +0 -42
  486. package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
  487. package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
  488. package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
  489. package/data/script-api/dw.system.RemoteInclude.md +0 -146
  490. package/data/script-api/dw.system.Request.md +0 -785
  491. package/data/script-api/dw.system.RequestHooks.md +0 -112
  492. package/data/script-api/dw.system.Response.md +0 -612
  493. package/data/script-api/dw.system.SearchStatus.md +0 -187
  494. package/data/script-api/dw.system.Session.md +0 -469
  495. package/data/script-api/dw.system.Site.md +0 -570
  496. package/data/script-api/dw.system.SitePreferences.md +0 -90
  497. package/data/script-api/dw.system.Status.md +0 -330
  498. package/data/script-api/dw.system.StatusItem.md +0 -273
  499. package/data/script-api/dw.system.System.md +0 -224
  500. package/data/script-api/dw.system.Transaction.md +0 -107
  501. package/data/script-api/dw.system.md +0 -32
  502. package/data/script-api/dw.template.ISML.md +0 -127
  503. package/data/script-api/dw.template.Velocity.md +0 -168
  504. package/data/script-api/dw.template.md +0 -7
  505. package/data/script-api/dw.util.ArrayList.md +0 -99
  506. package/data/script-api/dw.util.Assert.md +0 -370
  507. package/data/script-api/dw.util.BigInteger.md +0 -283
  508. package/data/script-api/dw.util.Bytes.md +0 -278
  509. package/data/script-api/dw.util.Calendar.md +0 -1051
  510. package/data/script-api/dw.util.Collection.md +0 -272
  511. package/data/script-api/dw.util.Currency.md +0 -147
  512. package/data/script-api/dw.util.DateUtils.md +0 -82
  513. package/data/script-api/dw.util.Decimal.md +0 -386
  514. package/data/script-api/dw.util.FilteringCollection.md +0 -140
  515. package/data/script-api/dw.util.Geolocation.md +0 -293
  516. package/data/script-api/dw.util.HashMap.md +0 -50
  517. package/data/script-api/dw.util.HashSet.md +0 -65
  518. package/data/script-api/dw.util.Iterator.md +0 -86
  519. package/data/script-api/dw.util.LinkedHashMap.md +0 -52
  520. package/data/script-api/dw.util.LinkedHashSet.md +0 -68
  521. package/data/script-api/dw.util.List.md +0 -429
  522. package/data/script-api/dw.util.Locale.md +0 -277
  523. package/data/script-api/dw.util.Map.md +0 -251
  524. package/data/script-api/dw.util.MapEntry.md +0 -68
  525. package/data/script-api/dw.util.MappingKey.md +0 -96
  526. package/data/script-api/dw.util.MappingMgr.md +0 -113
  527. package/data/script-api/dw.util.PropertyComparator.md +0 -122
  528. package/data/script-api/dw.util.SecureEncoder.md +0 -582
  529. package/data/script-api/dw.util.SecureFilter.md +0 -572
  530. package/data/script-api/dw.util.SeekableIterator.md +0 -187
  531. package/data/script-api/dw.util.Set.md +0 -39
  532. package/data/script-api/dw.util.SortedMap.md +0 -148
  533. package/data/script-api/dw.util.SortedSet.md +0 -173
  534. package/data/script-api/dw.util.StringUtils.md +0 -655
  535. package/data/script-api/dw.util.Template.md +0 -141
  536. package/data/script-api/dw.util.UUIDUtils.md +0 -34
  537. package/data/script-api/dw.util.md +0 -37
  538. package/data/script-api/dw.value.EnumValue.md +0 -105
  539. package/data/script-api/dw.value.MimeEncodedText.md +0 -131
  540. package/data/script-api/dw.value.Money.md +0 -526
  541. package/data/script-api/dw.value.Quantity.md +0 -299
  542. package/data/script-api/dw.value.md +0 -9
  543. package/data/script-api/dw.web.CSRFProtection.md +0 -105
  544. package/data/script-api/dw.web.ClickStream.md +0 -177
  545. package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
  546. package/data/script-api/dw.web.Cookie.md +0 -431
  547. package/data/script-api/dw.web.Cookies.md +0 -59
  548. package/data/script-api/dw.web.Form.md +0 -84
  549. package/data/script-api/dw.web.FormAction.md +0 -195
  550. package/data/script-api/dw.web.FormElement.md +0 -211
  551. package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
  552. package/data/script-api/dw.web.FormField.md +0 -642
  553. package/data/script-api/dw.web.FormFieldOption.md +0 -211
  554. package/data/script-api/dw.web.FormFieldOptions.md +0 -49
  555. package/data/script-api/dw.web.FormGroup.md +0 -222
  556. package/data/script-api/dw.web.FormList.md +0 -134
  557. package/data/script-api/dw.web.FormListItem.md +0 -57
  558. package/data/script-api/dw.web.Forms.md +0 -25
  559. package/data/script-api/dw.web.HttpParameter.md +0 -462
  560. package/data/script-api/dw.web.HttpParameterMap.md +0 -194
  561. package/data/script-api/dw.web.LoopIterator.md +0 -231
  562. package/data/script-api/dw.web.PageMetaData.md +0 -197
  563. package/data/script-api/dw.web.PageMetaTag.md +0 -173
  564. package/data/script-api/dw.web.PagingModel.md +0 -407
  565. package/data/script-api/dw.web.Resource.md +0 -147
  566. package/data/script-api/dw.web.URL.md +0 -174
  567. package/data/script-api/dw.web.URLAction.md +0 -95
  568. package/data/script-api/dw.web.URLParameter.md +0 -52
  569. package/data/script-api/dw.web.URLRedirect.md +0 -72
  570. package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
  571. package/data/script-api/dw.web.URLUtils.md +0 -1357
  572. package/data/script-api/dw.web.md +0 -34
  573. package/data/script-api/dw.ws.Port.md +0 -126
  574. package/data/script-api/dw.ws.WSUtil.md +0 -728
  575. package/data/script-api/dw.ws.WebReference2.md +0 -137
  576. package/data/script-api/dw.ws.md +0 -8
  577. package/data/script-api/index.md +0 -40
@@ -1,124 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class Library
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.object.PersistentObject](dw.object.PersistentObject.md)
6
- - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
7
- - [dw.content.Library](dw.content.Library.md)
8
-
9
- Class representing a collection of [Content](dw.content.Content.md) assets, and a
10
- [Folder](dw.content.Folder.md) hierarchy organizing these content assets.
11
- Currently only one library is allowed per site. An instance of this library
12
- can be obtained by calling [ContentMgr.getSiteLibrary()](dw.content.ContentMgr.md#getsitelibrary).
13
-
14
-
15
-
16
- ## Property Summary
17
-
18
- | Property | Description |
19
- | --- | --- |
20
- | [CMSChannelID](#cmschannelid): [String](TopLevel.String.md) `(read-only)` | Returns the CMS channel of the library. |
21
- | [ID](#id): [String](TopLevel.String.md) `(read-only)` | Returns the ID of this library. |
22
- | [displayName](#displayname): [String](TopLevel.String.md) `(read-only)` | Returns the display name for the library as known in the current locale or null if it cannot be found. |
23
- | [root](#root): [Folder](dw.content.Folder.md) `(read-only)` | Returns the root folder for this library. |
24
-
25
- ## Constructor Summary
26
-
27
- This class does not have a constructor, so you cannot create it directly.
28
- ## Method Summary
29
-
30
- | Method | Description |
31
- | --- | --- |
32
- | [getCMSChannelID](dw.content.Library.md#getcmschannelid)() | Returns the CMS channel of the library. |
33
- | [getDisplayName](dw.content.Library.md#getdisplayname)() | Returns the display name for the library as known in the current locale or null if it cannot be found. |
34
- | [getID](dw.content.Library.md#getid)() | Returns the ID of this library. |
35
- | [getRoot](dw.content.Library.md#getroot)() | Returns the root folder for this library. |
36
-
37
- ### Methods inherited from class ExtensibleObject
38
-
39
- [describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
40
- ### Methods inherited from class PersistentObject
41
-
42
- [getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
43
- ### Methods inherited from class Object
44
-
45
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
46
- ## Property Details
47
-
48
- ### CMSChannelID
49
- - CMSChannelID: [String](TopLevel.String.md) `(read-only)`
50
- - : Returns the CMS channel of the library.
51
-
52
-
53
- ---
54
-
55
- ### ID
56
- - ID: [String](TopLevel.String.md) `(read-only)`
57
- - : Returns the ID of this library.
58
-
59
-
60
- ---
61
-
62
- ### displayName
63
- - displayName: [String](TopLevel.String.md) `(read-only)`
64
- - : Returns the display name for the library as known in the current
65
- locale or null if it cannot be found.
66
-
67
-
68
-
69
- ---
70
-
71
- ### root
72
- - root: [Folder](dw.content.Folder.md) `(read-only)`
73
- - : Returns the root folder for this library.
74
-
75
-
76
- ---
77
-
78
- ## Method Details
79
-
80
- ### getCMSChannelID()
81
- - getCMSChannelID(): [String](TopLevel.String.md)
82
- - : Returns the CMS channel of the library.
83
-
84
- **Returns:**
85
- - the CMS channel of the library
86
-
87
-
88
- ---
89
-
90
- ### getDisplayName()
91
- - getDisplayName(): [String](TopLevel.String.md)
92
- - : Returns the display name for the library as known in the current
93
- locale or null if it cannot be found.
94
-
95
-
96
- **Returns:**
97
- - the display name for the library as known in the current
98
- locale or null if it cannot be found.
99
-
100
-
101
-
102
- ---
103
-
104
- ### getID()
105
- - getID(): [String](TopLevel.String.md)
106
- - : Returns the ID of this library.
107
-
108
- **Returns:**
109
- - the ID of this library.
110
-
111
-
112
- ---
113
-
114
- ### getRoot()
115
- - getRoot(): [Folder](dw.content.Folder.md)
116
- - : Returns the root folder for this library.
117
-
118
- **Returns:**
119
- - the root Folder for this library.
120
-
121
-
122
- ---
123
-
124
- <!-- prettier-ignore-end -->
@@ -1,150 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class MarkupText
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.content.MarkupText](dw.content.MarkupText.md)
6
-
7
- The class represents a content snippet with markup. This is typically a
8
- HTML content snippet. The class also processes the special links from
9
- Commerce Cloud Digital content management and automatically rewrites them into
10
- links for use in the storefront.
11
-
12
-
13
- The following special links can be used inside of a MarkupText:
14
-
15
-
16
-
17
- - `**$url('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$**`
18
-
19
- _Description:_
20
- The`$url()$`function creates and absolute URL and retains the protocol incoming
21
- request.
22
- _Example:_
23
- MarkupText:
24
- &nbsp;&nbsp;&nbsp;`$url('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`
25
- is rewritten to:
26
- &nbsp;&nbsp;&nbsp;`http://<host>:<port>/on/demandware.store/<current site>/default/MyLinkPipeline-Start?key1=value1&key2=value2`
27
- Note that the incoming protocol was http in the example above.
28
- - `**$httpUrl('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$**`
29
-
30
- _Description:_
31
- The`$httpUrl()$`function creates an absolute URL but always with the fix protocol
32
- "http". The protocol type of the incomming request is ignored.
33
-
34
- _Example:_
35
- MarkupText:
36
- &nbsp;&nbsp;&nbsp;`$httpUrl('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`
37
- is rewritten to:
38
- &nbsp;&nbsp;&nbsp;`http://<host>:'<port>/on/demandware.store/<current site>/default/MyLinkPipeline-Start?key1=value1&key2=value2`
39
- - `**$httpsUrl('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$**`
40
-
41
- _Description:_
42
- The`$httpsUrl()$`function creates an absolute URL but always with the fix protocol
43
- "https". The protocol type of the incomming request is ignored.
44
- _Example:_
45
- MarkupText:
46
- &nbsp;&nbsp;&nbsp;`$httpsUrl('MyLinkPipeline-Start', 'key1', 'value1', 'key2', 'value2')$`
47
- is rewritten to:
48
- &nbsp;&nbsp;&nbsp;`https://<host>:<port>/on/demandware.store/<current site>/default/MyLinkPipeline-Start?key1=value1&key2=value2`
49
-
50
- - `**$include('<pipeline>' [, '<key1>', '<value1>', '<key2>', '<value2>', ...])$**`
51
-
52
- _Description:_
53
- The`$include()$`function creates a relative URL which is post processed by the
54
- Commerce Cloud Digital Webadapter. The result is the content generated by the given pipeline call.
55
- _Example:_
56
- MarkupText:
57
- &nbsp;&nbsp;&nbsp;`$include('MyIncludePipeline-Start','key1', 'value1', 'key2' ,'value2')$`
58
- results in the content delivered by the 'MyIncludePipeline-Start' pipeline.
59
- - `**...?$staticlink$**`
60
-
61
- _Description:_
62
- The`$staticlink$`function can be used to create a URL to a static resource
63
- (such as an image). The URL being generated depends on the owner of the MarkupText instance.
64
- For example, a product's long description (which is a MarkupText) will generate
65
- links to static resources within the catalog. Possible URL targets are catalogs
66
- (for catalog related objects like products and categories), the content library
67
- (for library related objects like folders and assets) or the organization
68
- (for all objects that are not catalog or library related).
69
- _Example:_
70
- MarkupText: (owned by a content asset)
71
- &nbsp;&nbsp;&nbsp;`<img src="demo/content/bullet.gif?$staticlink$">`
72
- is rewritten to:
73
- &nbsp;&nbsp;&nbsp;`<img src="/on/demandware.static/<current site>/<library>/default/v1178201405900/demo/content/bullet.gif">`
74
-
75
-
76
-
77
- Note: The comma symbol `,` is not supported in parameter values for the link functions.
78
-
79
-
80
-
81
- ## Property Summary
82
-
83
- | Property | Description |
84
- | --- | --- |
85
- | [markup](#markup): [String](TopLevel.String.md) `(read-only)` | Returns the content with all links rewritten for storefront use. |
86
- | [source](#source): [String](TopLevel.String.md) `(read-only)` | Returns the original content source, without any links re-written. |
87
-
88
- ## Constructor Summary
89
-
90
- This class does not have a constructor, so you cannot create it directly.
91
- ## Method Summary
92
-
93
- | Method | Description |
94
- | --- | --- |
95
- | [getMarkup](dw.content.MarkupText.md#getmarkup)() | Returns the content with all links rewritten for storefront use. |
96
- | [getSource](dw.content.MarkupText.md#getsource)() | Returns the original content source, without any links re-written. |
97
- | [toString](dw.content.MarkupText.md#tostring)() | Returns a string representation of this class, the same as getMarkup(). |
98
-
99
- ### Methods inherited from class Object
100
-
101
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
102
- ## Property Details
103
-
104
- ### markup
105
- - markup: [String](TopLevel.String.md) `(read-only)`
106
- - : Returns the content with all links rewritten for storefront use.
107
-
108
-
109
- ---
110
-
111
- ### source
112
- - source: [String](TopLevel.String.md) `(read-only)`
113
- - : Returns the original content source, without any links re-written.
114
-
115
-
116
- ---
117
-
118
- ## Method Details
119
-
120
- ### getMarkup()
121
- - getMarkup(): [String](TopLevel.String.md)
122
- - : Returns the content with all links rewritten for storefront use.
123
-
124
- **Returns:**
125
- - the content with all links rewritten for storefront use.
126
-
127
-
128
- ---
129
-
130
- ### getSource()
131
- - getSource(): [String](TopLevel.String.md)
132
- - : Returns the original content source, without any links re-written.
133
-
134
- **Returns:**
135
- - the original content source, without any links re-written.
136
-
137
-
138
- ---
139
-
140
- ### toString()
141
- - toString(): [String](TopLevel.String.md)
142
- - : Returns a string representation of this class, the same as getMarkup().
143
-
144
- **Returns:**
145
- - a string representation of this class, the same as getMarkup().
146
-
147
-
148
- ---
149
-
150
- <!-- prettier-ignore-end -->
@@ -1,367 +0,0 @@
1
- <!-- prettier-ignore-start -->
2
- # Class MediaFile
3
-
4
- - [TopLevel.Object](TopLevel.Object.md)
5
- - [dw.content.MediaFile](dw.content.MediaFile.md)
6
-
7
- This class represents references to media content (such as images)
8
- located within Commerce Cloud Digital or on external systems.
9
-
10
-
11
- Parameter `transform`:
12
-
13
-
14
- Some methods allow the specification of image transformation parameters. Image
15
- transformation is only performed if the Dynamic Imaging Service (DIS) is available
16
- for the Commerce Cloud Digital instance, otherwise a standard static content URL
17
- is returned. The to-be-transformed image needs to be hosted on Commerce Cloud
18
- Digital.
19
-
20
-
21
- Image transformation parameters are specified as JavaScript object literal. They
22
- are translated into URL parameters. See [Create Image Transformation URLs.](https://help.salesforce.com/s/articleView?id=cc.b2c\_creating\_image\_transformation\_urls.htm)
23
-
24
-
25
- | Type of transformation | Parameters | Description |
26
- | --- |--- |--- |
27
- | Scale an image | `scaleWidth`<br/> `scaleHeight`<br/> `scaleMode` | The `scaleWidth` and `scaleHeight` parameters are both integers; setting one of these parameters triggers a scaling operation. If both are provided, the one that scales the image less is used to calculate the scale factor. The image is then automatically cropped accord to the second dimension, with a centered position of the cropped area. If the parameter would scale the image larger, only this operation is applied, if the image remains within acceptable pixel dimensions.<p/> Note: `scaleMode` can only be used in combination with `scaleHeight` and `scaleWidth`.<p/> The `scaleMode` parameter can be set to `cut` or `fit`. The default `scaleMode` is `cut`, the behavior of which is explained above. If you specify `fit` as the `scaleMode`, the system scales the image into the given box of dimensions while keeping the aspect ratio (possibly resulting in a smaller image in one dimension). |
28
- | Overlay an image | `imageX`<br/> `imageY`<br/> `imageURI` | The `imageX` and `imageY` parameters are both integers. Valid values for these parameters are 0 or greater.<p/> Supported formats are `png`, `jpg`, `jp2`, and `gif`.<p/> The `imageURI` parameter can be set to the absolute path of the overlaid image. The value of the `imageURI` parameter must be given in proper URL encoding, and it cannot exceed 400 characters in length. The path may include query string parameters, which supports dynamically generating the overlaid image itself through this service; that is, the overlaid image can itself be a transformed image.<p/> If the overlaid image extends over the primary image's boundaries, the overlaid image is cropped so that it fits directly over the primary image. |
29
- | Crop an image | `cropX`<br/> `cropY`<br/> `cropWidth`<br/> `cropHeight` | The `cropX`, `cropY`, `cropWidth`, `cropHeight` parameters are integers. All four parameters must be specified to trigger a cropping operation.<p/> Valid values for the `cropX` and `cropY` parameters are 0 or greater. If the crop location defined by `cropX` and `cropY` is outside the image area, nothing is cropped.<p/> Valid values for the `cropWidth` and `cropHeight` parameters are 10 or greater. If the `cropWidth` and `cropHeight` parameters specify a size that is greater than the original image, the crop area is reduced to the actual image area. If `cropWidth` and `cropHeight` are 0 or less, no transformation is applied. |
30
- | Format an image | `format` | The `format` parameter specifies the target format of image. Supported formats are `png`, `jpg`, `jp2`, and `gif`. If no target format is specified, no format conversion is performed.<p/> The attribute value must reference the source image. Source image's format is recognized by the file extension which must be `tif`, `tiff`, `jpg`, `jpeg`, `png`, or `gif`.<p/> In the generated URL the file extension of the target format is used in the URL path. This is to make sure the image is loaded from an URL with a matching file extension. The source format is provided as URL parameter. |
31
- | Adjust image compression quality | `quality` | The `quality` parameter specifies a quality setting for `jpg` and `jp2` images, and specifies the compression level for `png` images.<p/> For `jpg` and `jp2` images, you can set values from 1–100 for the highest quality. The default quality is 80. If you're not changing the default quality, you don't need to pass in a value.<p/> For `png` images, the quality setting has no effect on the appearance of the `png`, since the compression is always lossless. Instead you can use the quality setting to set the zlib compression level and filter-type for PNG images. The tens digit sets the zlib compression level(1-9). The ones digit sets the filter type.<p/> If the `png` setting is not present or set to 0, it uses a default value of 75. If this setting is set to 100, it actually equals the quality setting 90. |
32
- | Adjust Metadata stripping | `strip` | The `strip` parameter specifies if metadata like EXIF and color profiles is stripped from the image during transformation.<p/> Valid values for the `strip` parameter are between `true` and `false`. The default is `true` |
33
- | Change background color | `bgcolor(color) or bgcolor(color+alpha)` | The `bgcolor` parameter specifies the background color for images that support transparency as well as JPEG images when being converted from a format that supports transparency. Optionally, alpha setting for PNG images are also supported.<p/> `bgcolor` expects a 6 digit hexadecimal value of RGB with an optional two hexadecimal characters representing alpha value that determines transparency.<p/> FF0000 = Red<p/> FF000077 = Red with 50% transparency<p/> Alpha values are optional. When the alpha value is omitted, the resulting color is opaque. Alpha values are only valid when the image output format is PNG. |
34
-
35
-
36
- Example:
37
-
38
- The following code
39
-
40
- `var url = product.getImage('thumbnail', 0).getImageURL({scaleWidth: 100, format: 'jpg'});`
41
-
42
- will produce an image transformation URL like
43
-
44
- `http://<image server host name>/.../on/demandware.static/.../<path to image>/image.jpg?sw=100&sfrm=png`.
45
-
46
-
47
-
48
- ## Property Summary
49
-
50
- | Property | Description |
51
- | --- | --- |
52
- | [URL](#url): [URL](dw.web.URL.md) `(read-only)` | Returns an URL to the referenced media file. |
53
- | [absURL](#absurl): [URL](dw.web.URL.md) `(read-only)` | Returns an absolute URL to the referenced media file. |
54
- | [alt](#alt): [String](TopLevel.String.md) `(read-only)` | Returns the alternative text assigned to the media file in current requests locale. |
55
- | [httpURL](#httpurl): [URL](dw.web.URL.md) `(read-only)` | Returns an absolute URL to the referenced media file. |
56
- | [httpsURL](#httpsurl): [URL](dw.web.URL.md) `(read-only)` | Returns an absolute URL to the referenced media file. |
57
- | [title](#title): [String](TopLevel.String.md) `(read-only)` | Returns the title assigned to the media file in current requests locale. |
58
- | ~~[url](#url): [URL](dw.web.URL.md)~~ `(read-only)` | Returns an URL to the referenced media file. |
59
- | [viewType](#viewtype): [String](TopLevel.String.md) `(read-only)` | Returns the view type annotation for the media file. |
60
-
61
- ## Constructor Summary
62
-
63
- This class does not have a constructor, so you cannot create it directly.
64
- ## Method Summary
65
-
66
- | Method | Description |
67
- | --- | --- |
68
- | [getAbsImageURL](dw.content.MediaFile.md#getabsimageurlobject)([Object](TopLevel.Object.md)) | Returns an URL to the referenced image file. |
69
- | [getAbsURL](dw.content.MediaFile.md#getabsurl)() | Returns an absolute URL to the referenced media file. |
70
- | [getAlt](dw.content.MediaFile.md#getalt)() | Returns the alternative text assigned to the media file in current requests locale. |
71
- | [getHttpImageURL](dw.content.MediaFile.md#gethttpimageurlobject)([Object](TopLevel.Object.md)) | Returns an URL to the referenced image file. |
72
- | [getHttpURL](dw.content.MediaFile.md#gethttpurl)() | Returns an absolute URL to the referenced media file. |
73
- | [getHttpsImageURL](dw.content.MediaFile.md#gethttpsimageurlobject)([Object](TopLevel.Object.md)) | Returns an URL to the referenced image file. |
74
- | [getHttpsURL](dw.content.MediaFile.md#gethttpsurl)() | Returns an absolute URL to the referenced media file. |
75
- | [getImageURL](dw.content.MediaFile.md#getimageurlobject)([Object](TopLevel.Object.md)) | Returns an URL to the referenced image file. |
76
- | [getTitle](dw.content.MediaFile.md#gettitle)() | Returns the title assigned to the media file in current requests locale. |
77
- | [getURL](dw.content.MediaFile.md#geturl)() | Returns an URL to the referenced media file. |
78
- | ~~[getUrl](dw.content.MediaFile.md#geturl)()~~ | Returns an URL to the referenced media file. |
79
- | [getViewType](dw.content.MediaFile.md#getviewtype)() | Returns the view type annotation for the media file. |
80
-
81
- ### Methods inherited from class Object
82
-
83
- [assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
84
- ## Property Details
85
-
86
- ### URL
87
- - URL: [URL](dw.web.URL.md) `(read-only)`
88
- - : Returns an URL to the referenced media file. The
89
- returned URL is a relative URL.
90
-
91
-
92
-
93
- ---
94
-
95
- ### absURL
96
- - absURL: [URL](dw.web.URL.md) `(read-only)`
97
- - : Returns an absolute URL to the referenced media file. The
98
- protocol for the reference is the current protocol of the current
99
- HTTP request.
100
-
101
-
102
-
103
- ---
104
-
105
- ### alt
106
- - alt: [String](TopLevel.String.md) `(read-only)`
107
- - : Returns the alternative text assigned to the media file in current
108
- requests locale. If no alternative text was assigned or if no defaulting
109
- rule was defined, the method returns null.
110
-
111
-
112
-
113
- ---
114
-
115
- ### httpURL
116
- - httpURL: [URL](dw.web.URL.md) `(read-only)`
117
- - : Returns an absolute URL to the referenced media file. The
118
- protocol is http.
119
-
120
-
121
-
122
- ---
123
-
124
- ### httpsURL
125
- - httpsURL: [URL](dw.web.URL.md) `(read-only)`
126
- - : Returns an absolute URL to the referenced media file. The
127
- protocol is https.
128
-
129
-
130
-
131
- ---
132
-
133
- ### title
134
- - title: [String](TopLevel.String.md) `(read-only)`
135
- - : Returns the title assigned to the media file in current requests locale.
136
- If no title was assigned or if no defaulting rule was defined, the
137
- method returns null.
138
-
139
-
140
-
141
- ---
142
-
143
- ### url
144
- - ~~url: [URL](dw.web.URL.md)~~ `(read-only)`
145
- - : Returns an URL to the referenced media file. The
146
- returned URL is a relative URL.
147
-
148
-
149
- **Deprecated:**
150
- :::warning
151
- Use [getURL()](dw.content.MediaFile.md#geturl) instead.
152
- :::
153
-
154
- ---
155
-
156
- ### viewType
157
- - viewType: [String](TopLevel.String.md) `(read-only)`
158
- - : Returns the view type annotation for the media file. The method returns
159
- null, if the media file has no view type annotation.
160
-
161
-
162
-
163
- ---
164
-
165
- ## Method Details
166
-
167
- ### getAbsImageURL(Object)
168
- - getAbsImageURL(transform: [Object](TopLevel.Object.md)): [URL](dw.web.URL.md)
169
- - : Returns an URL to the referenced image file. Image transformation
170
- can be applied to the image. The protocol for the reference is the
171
- current protocol of the current HTTP request.
172
-
173
- Image transformation can only be applied to images that are hosted on
174
- Commerce Cloud Digital.
175
-
176
-
177
- **Parameters:**
178
- - transform - Object with transformation parameters (see class header)
179
-
180
- **Returns:**
181
- - an absolute URL to the referenced media file. The
182
- protocol for the reference is the current protocol of the current
183
- HTTP request. If the referenced media file is hosted externally,
184
- an URL to the external file is returned.
185
-
186
-
187
-
188
- ---
189
-
190
- ### getAbsURL()
191
- - getAbsURL(): [URL](dw.web.URL.md)
192
- - : Returns an absolute URL to the referenced media file. The
193
- protocol for the reference is the current protocol of the current
194
- HTTP request.
195
-
196
-
197
- **Returns:**
198
- - an absolute URL to the referenced media file. The
199
- protocol for the reference is the current protocol of the current
200
- HTTP request.
201
-
202
-
203
-
204
- ---
205
-
206
- ### getAlt()
207
- - getAlt(): [String](TopLevel.String.md)
208
- - : Returns the alternative text assigned to the media file in current
209
- requests locale. If no alternative text was assigned or if no defaulting
210
- rule was defined, the method returns null.
211
-
212
-
213
- **Returns:**
214
- - the alternative text annotated to this media file or null
215
-
216
-
217
- ---
218
-
219
- ### getHttpImageURL(Object)
220
- - getHttpImageURL(transform: [Object](TopLevel.Object.md)): [URL](dw.web.URL.md)
221
- - : Returns an URL to the referenced image file. Image transformation
222
- can be applied to the image. The protocol is http.
223
-
224
- Image transformation can only be applied to images that are hosted on
225
- Commerce Cloud Digital.
226
-
227
-
228
- **Parameters:**
229
- - transform - Object with transformation parameters (see class header)
230
-
231
- **Returns:**
232
- - an absolute URL to the referenced media file. The
233
- protocol is http. If the referenced media file is hosted externally,
234
- an URL to the external file is returned.
235
-
236
-
237
-
238
- ---
239
-
240
- ### getHttpURL()
241
- - getHttpURL(): [URL](dw.web.URL.md)
242
- - : Returns an absolute URL to the referenced media file. The
243
- protocol is http.
244
-
245
-
246
- **Returns:**
247
- - an absolute URL to the referenced media file. The
248
- protocol is http.
249
-
250
-
251
-
252
- ---
253
-
254
- ### getHttpsImageURL(Object)
255
- - getHttpsImageURL(transform: [Object](TopLevel.Object.md)): [URL](dw.web.URL.md)
256
- - : Returns an URL to the referenced image file. Image transformation
257
- can be applied to the image. The protocol is https.
258
-
259
- Image transformation can only be applied to images that are hosted on
260
- Commerce Cloud Digital.
261
-
262
-
263
- **Parameters:**
264
- - transform - Object with transformation parameters (see class header)
265
-
266
- **Returns:**
267
- - an absolute URL to the referenced media file. The
268
- protocol is https. If the referenced media file is hosted externally,
269
- an URL to the external file is returned.
270
-
271
-
272
-
273
- ---
274
-
275
- ### getHttpsURL()
276
- - getHttpsURL(): [URL](dw.web.URL.md)
277
- - : Returns an absolute URL to the referenced media file. The
278
- protocol is https.
279
-
280
-
281
- **Returns:**
282
- - an absolute URL to the referenced media file. The
283
- protocol is https.
284
-
285
-
286
-
287
- ---
288
-
289
- ### getImageURL(Object)
290
- - getImageURL(transform: [Object](TopLevel.Object.md)): [URL](dw.web.URL.md)
291
- - : Returns an URL to the referenced image file. Image transformation
292
- can be applied to the image.
293
-
294
- Image transformation can only be applied to images that are hosted on
295
- Commerce Cloud Digital.
296
-
297
-
298
- **Parameters:**
299
- - transform - Object with transformation parameters (see class header)
300
-
301
- **Returns:**
302
- - an URL to the referenced media file. The
303
- returned URL is a relative URL. If the referenced media file is hosted
304
- externally, an URL to the external file is returned.
305
-
306
-
307
-
308
- ---
309
-
310
- ### getTitle()
311
- - getTitle(): [String](TopLevel.String.md)
312
- - : Returns the title assigned to the media file in current requests locale.
313
- If no title was assigned or if no defaulting rule was defined, the
314
- method returns null.
315
-
316
-
317
- **Returns:**
318
- - the title annotated to this media file or null
319
-
320
-
321
- ---
322
-
323
- ### getURL()
324
- - getURL(): [URL](dw.web.URL.md)
325
- - : Returns an URL to the referenced media file. The
326
- returned URL is a relative URL.
327
-
328
-
329
- **Returns:**
330
- - an URL to the referenced media file. The
331
- returned URL is a relative URL.
332
-
333
-
334
-
335
- ---
336
-
337
- ### getUrl()
338
- - ~~getUrl(): [URL](dw.web.URL.md)~~
339
- - : Returns an URL to the referenced media file. The
340
- returned URL is a relative URL.
341
-
342
-
343
- **Returns:**
344
- - an URL to the referenced media file. The
345
- returned URL is a relative URL.
346
-
347
-
348
- **Deprecated:**
349
- :::warning
350
- Use [getURL()](dw.content.MediaFile.md#geturl) instead.
351
- :::
352
-
353
- ---
354
-
355
- ### getViewType()
356
- - getViewType(): [String](TopLevel.String.md)
357
- - : Returns the view type annotation for the media file. The method returns
358
- null, if the media file has no view type annotation.
359
-
360
-
361
- **Returns:**
362
- - the view type annotated to this media file or null
363
-
364
-
365
- ---
366
-
367
- <!-- prettier-ignore-end -->
@@ -1,15 +0,0 @@
1
- # Package dw.content
2
-
3
- ## Classes
4
- | Class | Description |
5
- | --- | --- |
6
- | [Content](dw.content.Content.md) | Class representing a Content asset in Commerce Cloud Digital. |
7
- | [ContentMgr](dw.content.ContentMgr.md) | Provides helper methods for getting content assets, library folders and the content library of the current site. |
8
- | [ContentSearchModel](dw.content.ContentSearchModel.md) | The class is the central interface to a content search result and a content search refinement. |
9
- | [ContentSearchRefinementDefinition](dw.content.ContentSearchRefinementDefinition.md) | This class provides an interface to refinement options for content search. |
10
- | [ContentSearchRefinements](dw.content.ContentSearchRefinements.md) | This class provides an interface to refinement options for the content asset search. |
11
- | [ContentSearchRefinementValue](dw.content.ContentSearchRefinementValue.md) | Represents the value of a content search refinement. |
12
- | [Folder](dw.content.Folder.md) | Class representing a folder for organizing content assets in Commerce Cloud Digital. |
13
- | [Library](dw.content.Library.md) | Class representing a collection of [Content](dw.content.Content.md) assets, and a [Folder](dw.content.Folder.md) hierarchy organizing these content assets. |
14
- | [MarkupText](dw.content.MarkupText.md) | The class represents a content snippet with markup. |
15
- | [MediaFile](dw.content.MediaFile.md) | This class represents references to media content (such as images) located within Commerce Cloud Digital or on external systems. |