@salesforce/b2c-tooling-sdk 1.19.0 → 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.
- package/data/help/index.json +9685 -0
- package/data/script-api/index.json +1 -528
- package/data/tooling/index.json +4 -4
- package/data/xsd/index.json +1 -1
- package/dist/esm/cli/base-command.js +5 -0
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/clients/index.d.ts +2 -0
- package/dist/esm/clients/index.js +1 -0
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/middleware-registry.d.ts +1 -1
- package/dist/esm/clients/middleware-registry.js.map +1 -1
- package/dist/esm/clients/preferences.d.ts +83 -0
- package/dist/esm/clients/preferences.generated.d.ts +1651 -0
- package/dist/esm/clients/preferences.generated.js +6 -0
- package/dist/esm/clients/preferences.generated.js.map +1 -0
- package/dist/esm/clients/preferences.js +64 -0
- package/dist/esm/clients/preferences.js.map +1 -0
- package/dist/esm/config/dw-json.d.ts +2 -0
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/mapping.js +4 -0
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/sources/dw-json-source.js +17 -4
- package/dist/esm/config/sources/dw-json-source.js.map +1 -1
- package/dist/esm/config/sources/env-source.js +2 -0
- package/dist/esm/config/sources/env-source.js.map +1 -1
- package/dist/esm/config/types.d.ts +14 -0
- package/dist/esm/discovery/detector.d.ts +1 -0
- package/dist/esm/discovery/detector.js +3 -1
- package/dist/esm/discovery/detector.js.map +1 -1
- package/dist/esm/discovery/index.d.ts +1 -1
- package/dist/esm/discovery/patterns/cartridges.js +4 -2
- package/dist/esm/discovery/patterns/cartridges.js.map +1 -1
- package/dist/esm/discovery/patterns/sfra.js +10 -5
- package/dist/esm/discovery/patterns/sfra.js.map +1 -1
- package/dist/esm/discovery/types.d.ts +20 -1
- package/dist/esm/docs/content-cache.d.ts +70 -0
- package/dist/esm/docs/content-cache.js +186 -0
- package/dist/esm/docs/content-cache.js.map +1 -0
- package/dist/esm/docs/index.d.ts +1 -0
- package/dist/esm/docs/index.js +2 -0
- package/dist/esm/docs/index.js.map +1 -1
- package/dist/esm/docs/search.js +34 -6
- package/dist/esm/docs/search.js.map +1 -1
- package/dist/esm/docs/types.d.ts +6 -1
- package/dist/esm/docs/types.js +1 -0
- package/dist/esm/docs/types.js.map +1 -1
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/operations/code/cartridges.d.ts +18 -0
- package/dist/esm/operations/code/cartridges.js +31 -20
- package/dist/esm/operations/code/cartridges.js.map +1 -1
- package/dist/esm/operations/jobs/discover.d.ts +46 -0
- package/dist/esm/operations/jobs/discover.js +87 -0
- package/dist/esm/operations/jobs/discover.js.map +1 -0
- package/dist/esm/operations/jobs/index.d.ts +2 -0
- package/dist/esm/operations/jobs/index.js +2 -0
- package/dist/esm/operations/jobs/index.js.map +1 -1
- package/dist/esm/operations/jobs/run.js +4 -3
- package/dist/esm/operations/jobs/run.js.map +1 -1
- package/package.json +5 -3
- package/specs/preferences-v1.yaml +2095 -0
- package/data/script-api/TopLevel.APIException.md +0 -119
- package/data/script-api/TopLevel.Array.md +0 -732
- package/data/script-api/TopLevel.ArrayBuffer.md +0 -97
- package/data/script-api/TopLevel.BigInt.md +0 -154
- package/data/script-api/TopLevel.Boolean.md +0 -83
- package/data/script-api/TopLevel.ConversionError.md +0 -51
- package/data/script-api/TopLevel.DataView.md +0 -271
- package/data/script-api/TopLevel.Date.md +0 -688
- package/data/script-api/TopLevel.ES6Iterator.md +0 -47
- package/data/script-api/TopLevel.Error.md +0 -124
- package/data/script-api/TopLevel.EvalError.md +0 -47
- package/data/script-api/TopLevel.Fault.md +0 -133
- package/data/script-api/TopLevel.Float32Array.md +0 -186
- package/data/script-api/TopLevel.Float64Array.md +0 -186
- package/data/script-api/TopLevel.Function.md +0 -114
- package/data/script-api/TopLevel.Generator.md +0 -132
- package/data/script-api/TopLevel.IOError.md +0 -98
- package/data/script-api/TopLevel.Int16Array.md +0 -186
- package/data/script-api/TopLevel.Int32Array.md +0 -186
- package/data/script-api/TopLevel.Int8Array.md +0 -186
- package/data/script-api/TopLevel.InternalError.md +0 -47
- package/data/script-api/TopLevel.Iterable.md +0 -44
- package/data/script-api/TopLevel.Iterator.md +0 -89
- package/data/script-api/TopLevel.JSON.md +0 -173
- package/data/script-api/TopLevel.Map.md +0 -189
- package/data/script-api/TopLevel.Math.md +0 -948
- package/data/script-api/TopLevel.Module.md +0 -152
- package/data/script-api/TopLevel.Namespace.md +0 -152
- package/data/script-api/TopLevel.Number.md +0 -404
- package/data/script-api/TopLevel.Object.md +0 -472
- package/data/script-api/TopLevel.QName.md +0 -147
- package/data/script-api/TopLevel.RangeError.md +0 -47
- package/data/script-api/TopLevel.ReferenceError.md +0 -47
- package/data/script-api/TopLevel.RegExp.md +0 -155
- package/data/script-api/TopLevel.Set.md +0 -150
- package/data/script-api/TopLevel.StopIteration.md +0 -36
- package/data/script-api/TopLevel.String.md +0 -1060
- package/data/script-api/TopLevel.Symbol.md +0 -196
- package/data/script-api/TopLevel.SyntaxError.md +0 -47
- package/data/script-api/TopLevel.SystemError.md +0 -99
- package/data/script-api/TopLevel.TypeError.md +0 -47
- package/data/script-api/TopLevel.URIError.md +0 -47
- package/data/script-api/TopLevel.Uint16Array.md +0 -186
- package/data/script-api/TopLevel.Uint32Array.md +0 -186
- package/data/script-api/TopLevel.Uint8Array.md +0 -186
- package/data/script-api/TopLevel.Uint8ClampedArray.md +0 -186
- package/data/script-api/TopLevel.WeakMap.md +0 -135
- package/data/script-api/TopLevel.WeakSet.md +0 -96
- package/data/script-api/TopLevel.XML.md +0 -922
- package/data/script-api/TopLevel.XMLList.md +0 -418
- package/data/script-api/TopLevel.XMLStreamError.md +0 -115
- package/data/script-api/TopLevel.arguments.md +0 -56
- package/data/script-api/TopLevel.global.md +0 -539
- package/data/script-api/TopLevel.md +0 -58
- package/data/script-api/dw.alert.Alert.md +0 -175
- package/data/script-api/dw.alert.Alerts.md +0 -256
- package/data/script-api/dw.alert.md +0 -7
- package/data/script-api/dw.campaign.ABTest.md +0 -63
- package/data/script-api/dw.campaign.ABTestMgr.md +0 -76
- package/data/script-api/dw.campaign.ABTestSegment.md +0 -107
- package/data/script-api/dw.campaign.AmountDiscount.md +0 -70
- package/data/script-api/dw.campaign.ApproachingDiscount.md +0 -157
- package/data/script-api/dw.campaign.BonusChoiceDiscount.md +0 -190
- package/data/script-api/dw.campaign.BonusDiscount.md +0 -59
- package/data/script-api/dw.campaign.Campaign.md +0 -346
- package/data/script-api/dw.campaign.CampaignMgr.md +0 -436
- package/data/script-api/dw.campaign.CampaignStatusCodes.md +0 -103
- package/data/script-api/dw.campaign.Coupon.md +0 -324
- package/data/script-api/dw.campaign.CouponMgr.md +0 -137
- package/data/script-api/dw.campaign.CouponRedemption.md +0 -87
- package/data/script-api/dw.campaign.CouponStatusCodes.md +0 -130
- package/data/script-api/dw.campaign.Discount.md +0 -271
- package/data/script-api/dw.campaign.DiscountPlan.md +0 -322
- package/data/script-api/dw.campaign.FixedPriceDiscount.md +0 -74
- package/data/script-api/dw.campaign.FixedPriceShippingDiscount.md +0 -74
- package/data/script-api/dw.campaign.FreeDiscount.md +0 -24
- package/data/script-api/dw.campaign.FreeShippingDiscount.md +0 -24
- package/data/script-api/dw.campaign.PercentageDiscount.md +0 -74
- package/data/script-api/dw.campaign.PercentageOptionDiscount.md +0 -59
- package/data/script-api/dw.campaign.PriceBookPriceDiscount.md +0 -56
- package/data/script-api/dw.campaign.Promotion.md +0 -939
- package/data/script-api/dw.campaign.PromotionMgr.md +0 -478
- package/data/script-api/dw.campaign.PromotionPlan.md +0 -378
- package/data/script-api/dw.campaign.SlotContent.md +0 -131
- package/data/script-api/dw.campaign.SourceCodeGroup.md +0 -83
- package/data/script-api/dw.campaign.SourceCodeInfo.md +0 -167
- package/data/script-api/dw.campaign.SourceCodeStatusCodes.md +0 -61
- package/data/script-api/dw.campaign.TotalFixedPriceDiscount.md +0 -56
- package/data/script-api/dw.campaign.md +0 -36
- package/data/script-api/dw.catalog.Catalog.md +0 -158
- package/data/script-api/dw.catalog.CatalogMgr.md +0 -161
- package/data/script-api/dw.catalog.Category.md +0 -1212
- package/data/script-api/dw.catalog.CategoryAssignment.md +0 -179
- package/data/script-api/dw.catalog.CategoryLink.md +0 -142
- package/data/script-api/dw.catalog.PriceBook.md +0 -215
- package/data/script-api/dw.catalog.PriceBookMgr.md +0 -176
- package/data/script-api/dw.catalog.Product.md +0 -2492
- package/data/script-api/dw.catalog.ProductActiveData.md +0 -1244
- package/data/script-api/dw.catalog.ProductAttributeModel.md +0 -409
- package/data/script-api/dw.catalog.ProductAvailabilityLevels.md +0 -125
- package/data/script-api/dw.catalog.ProductAvailabilityModel.md +0 -516
- package/data/script-api/dw.catalog.ProductInventoryList.md +0 -136
- package/data/script-api/dw.catalog.ProductInventoryMgr.md +0 -132
- package/data/script-api/dw.catalog.ProductInventoryRecord.md +0 -638
- package/data/script-api/dw.catalog.ProductLink.md +0 -166
- package/data/script-api/dw.catalog.ProductMgr.md +0 -136
- package/data/script-api/dw.catalog.ProductOption.md +0 -189
- package/data/script-api/dw.catalog.ProductOptionModel.md +0 -209
- package/data/script-api/dw.catalog.ProductOptionValue.md +0 -132
- package/data/script-api/dw.catalog.ProductPriceInfo.md +0 -170
- package/data/script-api/dw.catalog.ProductPriceModel.md +0 -988
- package/data/script-api/dw.catalog.ProductPriceTable.md +0 -121
- package/data/script-api/dw.catalog.ProductSearchHit.md +0 -702
- package/data/script-api/dw.catalog.ProductSearchModel.md +0 -1894
- package/data/script-api/dw.catalog.ProductSearchRefinementDefinition.md +0 -99
- package/data/script-api/dw.catalog.ProductSearchRefinementValue.md +0 -80
- package/data/script-api/dw.catalog.ProductSearchRefinements.md +0 -265
- package/data/script-api/dw.catalog.ProductVariationAttribute.md +0 -107
- package/data/script-api/dw.catalog.ProductVariationAttributeValue.md +0 -215
- package/data/script-api/dw.catalog.ProductVariationModel.md +0 -1010
- package/data/script-api/dw.catalog.Recommendation.md +0 -327
- package/data/script-api/dw.catalog.SearchModel.md +0 -769
- package/data/script-api/dw.catalog.SearchRefinementDefinition.md +0 -145
- package/data/script-api/dw.catalog.SearchRefinementValue.md +0 -194
- package/data/script-api/dw.catalog.SearchRefinements.md +0 -238
- package/data/script-api/dw.catalog.SortingOption.md +0 -120
- package/data/script-api/dw.catalog.SortingRule.md +0 -53
- package/data/script-api/dw.catalog.Store.md +0 -484
- package/data/script-api/dw.catalog.StoreGroup.md +0 -95
- package/data/script-api/dw.catalog.StoreInventoryFilter.md +0 -112
- package/data/script-api/dw.catalog.StoreInventoryFilterValue.md +0 -111
- package/data/script-api/dw.catalog.StoreMgr.md +0 -223
- package/data/script-api/dw.catalog.Variant.md +0 -1000
- package/data/script-api/dw.catalog.VariationGroup.md +0 -869
- package/data/script-api/dw.catalog.md +0 -50
- package/data/script-api/dw.content.Content.md +0 -481
- package/data/script-api/dw.content.ContentMgr.md +0 -147
- package/data/script-api/dw.content.ContentSearchModel.md +0 -618
- package/data/script-api/dw.content.ContentSearchRefinementDefinition.md +0 -61
- package/data/script-api/dw.content.ContentSearchRefinementValue.md +0 -22
- package/data/script-api/dw.content.ContentSearchRefinements.md +0 -218
- package/data/script-api/dw.content.Folder.md +0 -432
- package/data/script-api/dw.content.Library.md +0 -124
- package/data/script-api/dw.content.MarkupText.md +0 -150
- package/data/script-api/dw.content.MediaFile.md +0 -367
- package/data/script-api/dw.content.md +0 -15
- package/data/script-api/dw.crypto.CertificateRef.md +0 -59
- package/data/script-api/dw.crypto.CertificateUtils.md +0 -162
- package/data/script-api/dw.crypto.Cipher.md +0 -1234
- package/data/script-api/dw.crypto.Encoding.md +0 -193
- package/data/script-api/dw.crypto.JWE.md +0 -245
- package/data/script-api/dw.crypto.JWEHeader.md +0 -147
- package/data/script-api/dw.crypto.JWS.md +0 -260
- package/data/script-api/dw.crypto.JWSHeader.md +0 -128
- package/data/script-api/dw.crypto.KeyRef.md +0 -77
- package/data/script-api/dw.crypto.Mac.md +0 -191
- package/data/script-api/dw.crypto.MessageDigest.md +0 -243
- package/data/script-api/dw.crypto.SecureRandom.md +0 -161
- package/data/script-api/dw.crypto.Signature.md +0 -241
- package/data/script-api/dw.crypto.WeakCipher.md +0 -725
- package/data/script-api/dw.crypto.WeakMac.md +0 -163
- package/data/script-api/dw.crypto.WeakMessageDigest.md +0 -220
- package/data/script-api/dw.crypto.WeakSignature.md +0 -208
- package/data/script-api/dw.crypto.X509Certificate.md +0 -180
- package/data/script-api/dw.crypto.md +0 -23
- package/data/script-api/dw.customer.AddressBook.md +0 -158
- package/data/script-api/dw.customer.AgentUserMgr.md +0 -94
- package/data/script-api/dw.customer.AgentUserStatusCodes.md +0 -164
- package/data/script-api/dw.customer.AuthenticationStatus.md +0 -157
- package/data/script-api/dw.customer.Credentials.md +0 -524
- package/data/script-api/dw.customer.Customer.md +0 -488
- package/data/script-api/dw.customer.CustomerActiveData.md +0 -563
- package/data/script-api/dw.customer.CustomerAddress.md +0 -666
- package/data/script-api/dw.customer.CustomerCDPData.md +0 -70
- package/data/script-api/dw.customer.CustomerContextMgr.md +0 -62
- package/data/script-api/dw.customer.CustomerGroup.md +0 -146
- package/data/script-api/dw.customer.CustomerList.md +0 -76
- package/data/script-api/dw.customer.CustomerMgr.md +0 -1046
- package/data/script-api/dw.customer.CustomerPasswordConstraints.md +0 -125
- package/data/script-api/dw.customer.CustomerPaymentInstrument.md +0 -161
- package/data/script-api/dw.customer.CustomerStatusCodes.md +0 -55
- package/data/script-api/dw.customer.EncryptedObject.md +0 -34
- package/data/script-api/dw.customer.ExternalProfile.md +0 -154
- package/data/script-api/dw.customer.OrderHistory.md +0 -167
- package/data/script-api/dw.customer.ProductList.md +0 -870
- package/data/script-api/dw.customer.ProductListItem.md +0 -469
- package/data/script-api/dw.customer.ProductListItemPurchase.md +0 -139
- package/data/script-api/dw.customer.ProductListMgr.md +0 -350
- package/data/script-api/dw.customer.ProductListRegistrant.md +0 -165
- package/data/script-api/dw.customer.Profile.md +0 -940
- package/data/script-api/dw.customer.Wallet.md +0 -136
- package/data/script-api/dw.customer.consent.ConsentStatusEntry.md +0 -92
- package/data/script-api/dw.customer.consent.MarketingConsentSubscription.md +0 -247
- package/data/script-api/dw.customer.consent.ShopperConsentErrorCodes.md +0 -74
- package/data/script-api/dw.customer.consent.ShopperConsentException.md +0 -63
- package/data/script-api/dw.customer.consent.ShopperConsentMgr.md +0 -152
- package/data/script-api/dw.customer.consent.md +0 -10
- package/data/script-api/dw.customer.md +0 -31
- package/data/script-api/dw.customer.oauth.OAuthAccessTokenResponse.md +0 -171
- package/data/script-api/dw.customer.oauth.OAuthFinalizedResponse.md +0 -75
- package/data/script-api/dw.customer.oauth.OAuthLoginFlowMgr.md +0 -165
- package/data/script-api/dw.customer.oauth.OAuthUserInfoResponse.md +0 -84
- package/data/script-api/dw.customer.oauth.md +0 -9
- package/data/script-api/dw.customer.shoppercontext.ShopperContext.md +0 -369
- package/data/script-api/dw.customer.shoppercontext.ShopperContextErrorCodes.md +0 -111
- package/data/script-api/dw.customer.shoppercontext.ShopperContextException.md +0 -77
- package/data/script-api/dw.customer.shoppercontext.ShopperContextMgr.md +0 -209
- package/data/script-api/dw.customer.shoppercontext.md +0 -9
- package/data/script-api/dw.experience.AspectAttributeValidationException.md +0 -25
- package/data/script-api/dw.experience.Component.md +0 -166
- package/data/script-api/dw.experience.ComponentRenderSettings.md +0 -130
- package/data/script-api/dw.experience.ComponentScriptContext.md +0 -148
- package/data/script-api/dw.experience.CustomEditor.md +0 -146
- package/data/script-api/dw.experience.CustomEditorResources.md +0 -100
- package/data/script-api/dw.experience.Page.md +0 -467
- package/data/script-api/dw.experience.PageMgr.md +0 -549
- package/data/script-api/dw.experience.PageScriptContext.md +0 -200
- package/data/script-api/dw.experience.Region.md +0 -119
- package/data/script-api/dw.experience.RegionRenderSettings.md +0 -207
- package/data/script-api/dw.experience.cms.CMSRecord.md +0 -125
- package/data/script-api/dw.experience.cms.md +0 -6
- package/data/script-api/dw.experience.image.FocalPoint.md +0 -71
- package/data/script-api/dw.experience.image.Image.md +0 -101
- package/data/script-api/dw.experience.image.ImageMetaData.md +0 -71
- package/data/script-api/dw.experience.image.md +0 -8
- package/data/script-api/dw.experience.md +0 -16
- package/data/script-api/dw.extensions.applepay.ApplePayHookResult.md +0 -254
- package/data/script-api/dw.extensions.applepay.ApplePayHooks.md +0 -572
- package/data/script-api/dw.extensions.applepay.md +0 -7
- package/data/script-api/dw.extensions.facebook.FacebookFeedHooks.md +0 -102
- package/data/script-api/dw.extensions.facebook.FacebookProduct.md +0 -1343
- package/data/script-api/dw.extensions.facebook.md +0 -7
- package/data/script-api/dw.extensions.paymentapi.PaymentApiHooks.md +0 -136
- package/data/script-api/dw.extensions.paymentapi.md +0 -6
- package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHookResult.md +0 -149
- package/data/script-api/dw.extensions.paymentrequest.PaymentRequestHooks.md +0 -356
- package/data/script-api/dw.extensions.paymentrequest.md +0 -7
- package/data/script-api/dw.extensions.payments.SalesforceAdyenPaymentIntent.md +0 -134
- package/data/script-api/dw.extensions.payments.SalesforceAdyenSavedPaymentMethod.md +0 -283
- package/data/script-api/dw.extensions.payments.SalesforceBancontactPaymentDetails.md +0 -88
- package/data/script-api/dw.extensions.payments.SalesforceCardPaymentDetails.md +0 -107
- package/data/script-api/dw.extensions.payments.SalesforceEpsPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforceIdealPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforceKlarnaPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrder.md +0 -263
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderAddress.md +0 -171
- package/data/script-api/dw.extensions.payments.SalesforcePayPalOrderPayer.md +0 -110
- package/data/script-api/dw.extensions.payments.SalesforcePayPalPaymentDetails.md +0 -88
- package/data/script-api/dw.extensions.payments.SalesforcePaymentDetails.md +0 -83
- package/data/script-api/dw.extensions.payments.SalesforcePaymentIntent.md +0 -273
- package/data/script-api/dw.extensions.payments.SalesforcePaymentMethod.md +0 -368
- package/data/script-api/dw.extensions.payments.SalesforcePaymentRequest.md +0 -1077
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md +0 -190
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md +0 -151
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md +0 -98
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsMgr.md +0 -989
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsSiteConfiguration.md +0 -202
- package/data/script-api/dw.extensions.payments.SalesforcePaymentsZone.md +0 -393
- package/data/script-api/dw.extensions.payments.SalesforceSepaDebitPaymentDetails.md +0 -63
- package/data/script-api/dw.extensions.payments.SalesforceVenmoPaymentDetails.md +0 -88
- package/data/script-api/dw.extensions.payments.md +0 -28
- package/data/script-api/dw.extensions.pinterest.PinterestAvailability.md +0 -85
- package/data/script-api/dw.extensions.pinterest.PinterestFeedHooks.md +0 -118
- package/data/script-api/dw.extensions.pinterest.PinterestOrder.md +0 -263
- package/data/script-api/dw.extensions.pinterest.PinterestOrderHooks.md +0 -89
- package/data/script-api/dw.extensions.pinterest.PinterestProduct.md +0 -677
- package/data/script-api/dw.extensions.pinterest.md +0 -10
- package/data/script-api/dw.io.CSVStreamReader.md +0 -128
- package/data/script-api/dw.io.CSVStreamWriter.md +0 -92
- package/data/script-api/dw.io.File.md +0 -729
- package/data/script-api/dw.io.FileReader.md +0 -70
- package/data/script-api/dw.io.FileWriter.md +0 -159
- package/data/script-api/dw.io.InputStream.md +0 -35
- package/data/script-api/dw.io.OutputStream.md +0 -38
- package/data/script-api/dw.io.PrintWriter.md +0 -66
- package/data/script-api/dw.io.RandomAccessFileReader.md +0 -183
- package/data/script-api/dw.io.Reader.md +0 -284
- package/data/script-api/dw.io.StringWriter.md +0 -89
- package/data/script-api/dw.io.Writer.md +0 -96
- package/data/script-api/dw.io.XMLIndentingStreamWriter.md +0 -121
- package/data/script-api/dw.io.XMLStreamConstants.md +0 -172
- package/data/script-api/dw.io.XMLStreamReader.md +0 -1181
- package/data/script-api/dw.io.XMLStreamWriter.md +0 -478
- package/data/script-api/dw.io.md +0 -21
- package/data/script-api/dw.job.JobExecution.md +0 -111
- package/data/script-api/dw.job.JobStepExecution.md +0 -136
- package/data/script-api/dw.job.md +0 -7
- package/data/script-api/dw.net.FTPClient.md +0 -621
- package/data/script-api/dw.net.FTPFileInfo.md +0 -132
- package/data/script-api/dw.net.HTTPClient.md +0 -775
- package/data/script-api/dw.net.HTTPClientLoggingConfig.md +0 -363
- package/data/script-api/dw.net.HTTPRequestPart.md +0 -296
- package/data/script-api/dw.net.Mail.md +0 -487
- package/data/script-api/dw.net.SFTPClient.md +0 -535
- package/data/script-api/dw.net.SFTPFileInfo.md +0 -128
- package/data/script-api/dw.net.WebDAVClient.md +0 -762
- package/data/script-api/dw.net.WebDAVFileInfo.md +0 -163
- package/data/script-api/dw.net.md +0 -15
- package/data/script-api/dw.object.ActiveData.md +0 -86
- package/data/script-api/dw.object.CustomAttributes.md +0 -165
- package/data/script-api/dw.object.CustomObject.md +0 -82
- package/data/script-api/dw.object.CustomObjectMgr.md +0 -478
- package/data/script-api/dw.object.Extensible.md +0 -71
- package/data/script-api/dw.object.ExtensibleObject.md +0 -85
- package/data/script-api/dw.object.Note.md +0 -118
- package/data/script-api/dw.object.ObjectAttributeDefinition.md +0 -542
- package/data/script-api/dw.object.ObjectAttributeGroup.md +0 -160
- package/data/script-api/dw.object.ObjectAttributeValueDefinition.md +0 -78
- package/data/script-api/dw.object.ObjectTypeDefinition.md +0 -239
- package/data/script-api/dw.object.PersistentObject.md +0 -92
- package/data/script-api/dw.object.SimpleExtensible.md +0 -53
- package/data/script-api/dw.object.SystemObjectMgr.md +0 -520
- package/data/script-api/dw.object.md +0 -19
- package/data/script-api/dw.order.AbstractItem.md +0 -220
- package/data/script-api/dw.order.AbstractItemCtnr.md +0 -219
- package/data/script-api/dw.order.Appeasement.md +0 -398
- package/data/script-api/dw.order.AppeasementItem.md +0 -104
- package/data/script-api/dw.order.Basket.md +0 -868
- package/data/script-api/dw.order.BasketMgr.md +0 -673
- package/data/script-api/dw.order.BonusDiscountLineItem.md +0 -309
- package/data/script-api/dw.order.CouponLineItem.md +0 -289
- package/data/script-api/dw.order.CreateAgentBasketLimitExceededException.md +0 -35
- package/data/script-api/dw.order.CreateBasketFromOrderException.md +0 -54
- package/data/script-api/dw.order.CreateCouponLineItemException.md +0 -67
- package/data/script-api/dw.order.CreateOrderException.md +0 -23
- package/data/script-api/dw.order.CreateTemporaryBasketLimitExceededException.md +0 -35
- package/data/script-api/dw.order.GiftCertificate.md +0 -530
- package/data/script-api/dw.order.GiftCertificateLineItem.md +0 -292
- package/data/script-api/dw.order.GiftCertificateMgr.md +0 -228
- package/data/script-api/dw.order.GiftCertificateStatusCodes.md +0 -108
- package/data/script-api/dw.order.Invoice.md +0 -571
- package/data/script-api/dw.order.InvoiceItem.md +0 -199
- package/data/script-api/dw.order.LineItem.md +0 -577
- package/data/script-api/dw.order.LineItemCtnr.md +0 -2429
- package/data/script-api/dw.order.LineItemTax.md +0 -142
- package/data/script-api/dw.order.Order.md +0 -2770
- package/data/script-api/dw.order.OrderAddress.md +0 -624
- package/data/script-api/dw.order.OrderItem.md +0 -613
- package/data/script-api/dw.order.OrderMgr.md +0 -1502
- package/data/script-api/dw.order.OrderPaymentInstrument.md +0 -231
- package/data/script-api/dw.order.OrderProcessStatusCodes.md +0 -146
- package/data/script-api/dw.order.PaymentCard.md +0 -220
- package/data/script-api/dw.order.PaymentInstrument.md +0 -1416
- package/data/script-api/dw.order.PaymentMethod.md +0 -257
- package/data/script-api/dw.order.PaymentMgr.md +0 -138
- package/data/script-api/dw.order.PaymentProcessor.md +0 -106
- package/data/script-api/dw.order.PaymentStatusCodes.md +0 -70
- package/data/script-api/dw.order.PaymentTransaction.md +0 -291
- package/data/script-api/dw.order.PriceAdjustment.md +0 -745
- package/data/script-api/dw.order.PriceAdjustmentLimitTypes.md +0 -61
- package/data/script-api/dw.order.ProductLineItem.md +0 -1749
- package/data/script-api/dw.order.ProductShippingCost.md +0 -101
- package/data/script-api/dw.order.ProductShippingLineItem.md +0 -336
- package/data/script-api/dw.order.ProductShippingModel.md +0 -143
- package/data/script-api/dw.order.Return.md +0 -396
- package/data/script-api/dw.order.ReturnCase.md +0 -463
- package/data/script-api/dw.order.ReturnCaseItem.md +0 -372
- package/data/script-api/dw.order.ReturnItem.md +0 -335
- package/data/script-api/dw.order.Shipment.md +0 -1132
- package/data/script-api/dw.order.ShipmentShippingCost.md +0 -54
- package/data/script-api/dw.order.ShipmentShippingModel.md +0 -203
- package/data/script-api/dw.order.ShippingLineItem.md +0 -315
- package/data/script-api/dw.order.ShippingLocation.md +0 -313
- package/data/script-api/dw.order.ShippingMethod.md +0 -251
- package/data/script-api/dw.order.ShippingMgr.md +0 -173
- package/data/script-api/dw.order.ShippingOrder.md +0 -630
- package/data/script-api/dw.order.ShippingOrderItem.md +0 -425
- package/data/script-api/dw.order.SumItem.md +0 -158
- package/data/script-api/dw.order.TaxGroup.md +0 -128
- package/data/script-api/dw.order.TaxItem.md +0 -74
- package/data/script-api/dw.order.TaxMgr.md +0 -314
- package/data/script-api/dw.order.TrackingInfo.md +0 -261
- package/data/script-api/dw.order.TrackingRef.md +0 -108
- package/data/script-api/dw.order.hooks.BasketMergeHooks.md +0 -87
- package/data/script-api/dw.order.hooks.CalculateHooks.md +0 -139
- package/data/script-api/dw.order.hooks.CheckoutHooks.md +0 -88
- package/data/script-api/dw.order.hooks.OrderHooks.md +0 -96
- package/data/script-api/dw.order.hooks.PaymentHooks.md +0 -325
- package/data/script-api/dw.order.hooks.ReturnHooks.md +0 -395
- package/data/script-api/dw.order.hooks.ShippingOrderHooks.md +0 -426
- package/data/script-api/dw.order.hooks.TaxHooks.md +0 -495
- package/data/script-api/dw.order.hooks.md +0 -13
- package/data/script-api/dw.order.md +0 -65
- package/data/script-api/dw.rpc.SOAPUtil.md +0 -736
- package/data/script-api/dw.rpc.Stub.md +0 -373
- package/data/script-api/dw.rpc.WebReference.md +0 -133
- package/data/script-api/dw.rpc.md +0 -8
- package/data/script-api/dw.sitemap.SitemapFile.md +0 -137
- package/data/script-api/dw.sitemap.SitemapMgr.md +0 -165
- package/data/script-api/dw.sitemap.md +0 -7
- package/data/script-api/dw.suggest.BrandSuggestions.md +0 -34
- package/data/script-api/dw.suggest.CategorySuggestions.md +0 -76
- package/data/script-api/dw.suggest.ContentSuggestions.md +0 -76
- package/data/script-api/dw.suggest.CustomSuggestions.md +0 -34
- package/data/script-api/dw.suggest.ProductSuggestions.md +0 -76
- package/data/script-api/dw.suggest.SearchPhraseSuggestions.md +0 -126
- package/data/script-api/dw.suggest.SuggestModel.md +0 -471
- package/data/script-api/dw.suggest.SuggestedCategory.md +0 -51
- package/data/script-api/dw.suggest.SuggestedContent.md +0 -51
- package/data/script-api/dw.suggest.SuggestedPhrase.md +0 -70
- package/data/script-api/dw.suggest.SuggestedProduct.md +0 -55
- package/data/script-api/dw.suggest.SuggestedTerm.md +0 -143
- package/data/script-api/dw.suggest.SuggestedTerms.md +0 -144
- package/data/script-api/dw.suggest.Suggestions.md +0 -206
- package/data/script-api/dw.suggest.md +0 -19
- package/data/script-api/dw.svc.FTPService.md +0 -140
- package/data/script-api/dw.svc.FTPServiceDefinition.md +0 -97
- package/data/script-api/dw.svc.HTTPFormService.md +0 -32
- package/data/script-api/dw.svc.HTTPFormServiceDefinition.md +0 -36
- package/data/script-api/dw.svc.HTTPService.md +0 -370
- package/data/script-api/dw.svc.HTTPServiceDefinition.md +0 -290
- package/data/script-api/dw.svc.LocalServiceRegistry.md +0 -63
- package/data/script-api/dw.svc.Result.md +0 -320
- package/data/script-api/dw.svc.SOAPService.md +0 -104
- package/data/script-api/dw.svc.SOAPServiceDefinition.md +0 -32
- package/data/script-api/dw.svc.Service.md +0 -276
- package/data/script-api/dw.svc.ServiceCallback.md +0 -282
- package/data/script-api/dw.svc.ServiceConfig.md +0 -114
- package/data/script-api/dw.svc.ServiceCredential.md +0 -162
- package/data/script-api/dw.svc.ServiceDefinition.md +0 -211
- package/data/script-api/dw.svc.ServiceProfile.md +0 -152
- package/data/script-api/dw.svc.ServiceRegistry.md +0 -118
- package/data/script-api/dw.svc.md +0 -22
- package/data/script-api/dw.system.AgentUserStatusCodes.md +0 -41
- package/data/script-api/dw.system.Cache.md +0 -126
- package/data/script-api/dw.system.CacheMgr.md +0 -70
- package/data/script-api/dw.system.HookMgr.md +0 -78
- package/data/script-api/dw.system.InternalObject.md +0 -47
- package/data/script-api/dw.system.JobProcessMonitor.md +0 -103
- package/data/script-api/dw.system.Log.md +0 -198
- package/data/script-api/dw.system.LogNDC.md +0 -75
- package/data/script-api/dw.system.Logger.md +0 -216
- package/data/script-api/dw.system.OrganizationPreferences.md +0 -53
- package/data/script-api/dw.system.Pipeline.md +0 -94
- package/data/script-api/dw.system.PipelineDictionary.md +0 -42
- package/data/script-api/dw.system.RESTErrorResponse.md +0 -102
- package/data/script-api/dw.system.RESTResponseMgr.md +0 -243
- package/data/script-api/dw.system.RESTSuccessResponse.md +0 -62
- package/data/script-api/dw.system.RemoteInclude.md +0 -146
- package/data/script-api/dw.system.Request.md +0 -785
- package/data/script-api/dw.system.RequestHooks.md +0 -112
- package/data/script-api/dw.system.Response.md +0 -612
- package/data/script-api/dw.system.SearchStatus.md +0 -187
- package/data/script-api/dw.system.Session.md +0 -469
- package/data/script-api/dw.system.Site.md +0 -570
- package/data/script-api/dw.system.SitePreferences.md +0 -90
- package/data/script-api/dw.system.Status.md +0 -330
- package/data/script-api/dw.system.StatusItem.md +0 -273
- package/data/script-api/dw.system.System.md +0 -224
- package/data/script-api/dw.system.Transaction.md +0 -107
- package/data/script-api/dw.system.md +0 -32
- package/data/script-api/dw.template.ISML.md +0 -127
- package/data/script-api/dw.template.Velocity.md +0 -168
- package/data/script-api/dw.template.md +0 -7
- package/data/script-api/dw.util.ArrayList.md +0 -99
- package/data/script-api/dw.util.Assert.md +0 -370
- package/data/script-api/dw.util.BigInteger.md +0 -283
- package/data/script-api/dw.util.Bytes.md +0 -278
- package/data/script-api/dw.util.Calendar.md +0 -1051
- package/data/script-api/dw.util.Collection.md +0 -272
- package/data/script-api/dw.util.Currency.md +0 -147
- package/data/script-api/dw.util.DateUtils.md +0 -82
- package/data/script-api/dw.util.Decimal.md +0 -386
- package/data/script-api/dw.util.FilteringCollection.md +0 -140
- package/data/script-api/dw.util.Geolocation.md +0 -293
- package/data/script-api/dw.util.HashMap.md +0 -50
- package/data/script-api/dw.util.HashSet.md +0 -65
- package/data/script-api/dw.util.Iterator.md +0 -86
- package/data/script-api/dw.util.LinkedHashMap.md +0 -52
- package/data/script-api/dw.util.LinkedHashSet.md +0 -68
- package/data/script-api/dw.util.List.md +0 -429
- package/data/script-api/dw.util.Locale.md +0 -277
- package/data/script-api/dw.util.Map.md +0 -251
- package/data/script-api/dw.util.MapEntry.md +0 -68
- package/data/script-api/dw.util.MappingKey.md +0 -96
- package/data/script-api/dw.util.MappingMgr.md +0 -113
- package/data/script-api/dw.util.PropertyComparator.md +0 -122
- package/data/script-api/dw.util.SecureEncoder.md +0 -582
- package/data/script-api/dw.util.SecureFilter.md +0 -572
- package/data/script-api/dw.util.SeekableIterator.md +0 -187
- package/data/script-api/dw.util.Set.md +0 -39
- package/data/script-api/dw.util.SortedMap.md +0 -148
- package/data/script-api/dw.util.SortedSet.md +0 -173
- package/data/script-api/dw.util.StringUtils.md +0 -655
- package/data/script-api/dw.util.Template.md +0 -141
- package/data/script-api/dw.util.UUIDUtils.md +0 -34
- package/data/script-api/dw.util.md +0 -37
- package/data/script-api/dw.value.EnumValue.md +0 -105
- package/data/script-api/dw.value.MimeEncodedText.md +0 -131
- package/data/script-api/dw.value.Money.md +0 -526
- package/data/script-api/dw.value.Quantity.md +0 -299
- package/data/script-api/dw.value.md +0 -9
- package/data/script-api/dw.web.CSRFProtection.md +0 -105
- package/data/script-api/dw.web.ClickStream.md +0 -177
- package/data/script-api/dw.web.ClickStreamEntry.md +0 -255
- package/data/script-api/dw.web.Cookie.md +0 -431
- package/data/script-api/dw.web.Cookies.md +0 -59
- package/data/script-api/dw.web.Form.md +0 -84
- package/data/script-api/dw.web.FormAction.md +0 -195
- package/data/script-api/dw.web.FormElement.md +0 -211
- package/data/script-api/dw.web.FormElementValidationResult.md +0 -170
- package/data/script-api/dw.web.FormField.md +0 -642
- package/data/script-api/dw.web.FormFieldOption.md +0 -211
- package/data/script-api/dw.web.FormFieldOptions.md +0 -49
- package/data/script-api/dw.web.FormGroup.md +0 -222
- package/data/script-api/dw.web.FormList.md +0 -134
- package/data/script-api/dw.web.FormListItem.md +0 -57
- package/data/script-api/dw.web.Forms.md +0 -25
- package/data/script-api/dw.web.HttpParameter.md +0 -462
- package/data/script-api/dw.web.HttpParameterMap.md +0 -194
- package/data/script-api/dw.web.LoopIterator.md +0 -231
- package/data/script-api/dw.web.PageMetaData.md +0 -197
- package/data/script-api/dw.web.PageMetaTag.md +0 -173
- package/data/script-api/dw.web.PagingModel.md +0 -407
- package/data/script-api/dw.web.Resource.md +0 -147
- package/data/script-api/dw.web.URL.md +0 -174
- package/data/script-api/dw.web.URLAction.md +0 -95
- package/data/script-api/dw.web.URLParameter.md +0 -52
- package/data/script-api/dw.web.URLRedirect.md +0 -72
- package/data/script-api/dw.web.URLRedirectMgr.md +0 -86
- package/data/script-api/dw.web.URLUtils.md +0 -1357
- package/data/script-api/dw.web.md +0 -34
- package/data/script-api/dw.ws.Port.md +0 -126
- package/data/script-api/dw.ws.WSUtil.md +0 -728
- package/data/script-api/dw.ws.WebReference2.md +0 -137
- package/data/script-api/dw.ws.md +0 -8
- package/data/script-api/index.md +0 -40
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class FocalPoint
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.experience.image.FocalPoint](dw.experience.image.FocalPoint.md)
|
|
6
|
-
|
|
7
|
-
This class represents an image focal point.
|
|
8
|
-
|
|
9
|
-
**See Also:**
|
|
10
|
-
- [Image](dw.experience.image.Image.md)
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## Property Summary
|
|
14
|
-
|
|
15
|
-
| Property | Description |
|
|
16
|
-
| --- | --- |
|
|
17
|
-
| [x](#x): [Number](TopLevel.Number.md) `(read-only)` | Returns the focal point abscissa. |
|
|
18
|
-
| [y](#y): [Number](TopLevel.Number.md) `(read-only)` | Returns the focal point ordinate. |
|
|
19
|
-
|
|
20
|
-
## Constructor Summary
|
|
21
|
-
|
|
22
|
-
This class does not have a constructor, so you cannot create it directly.
|
|
23
|
-
## Method Summary
|
|
24
|
-
|
|
25
|
-
| Method | Description |
|
|
26
|
-
| --- | --- |
|
|
27
|
-
| [getX](dw.experience.image.FocalPoint.md#getx)() | Returns the focal point abscissa. |
|
|
28
|
-
| [getY](dw.experience.image.FocalPoint.md#gety)() | Returns the focal point ordinate. |
|
|
29
|
-
|
|
30
|
-
### Methods inherited from class Object
|
|
31
|
-
|
|
32
|
-
[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)
|
|
33
|
-
## Property Details
|
|
34
|
-
|
|
35
|
-
### x
|
|
36
|
-
- x: [Number](TopLevel.Number.md) `(read-only)`
|
|
37
|
-
- : Returns the focal point abscissa.
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
---
|
|
41
|
-
|
|
42
|
-
### y
|
|
43
|
-
- y: [Number](TopLevel.Number.md) `(read-only)`
|
|
44
|
-
- : Returns the focal point ordinate.
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
## Method Details
|
|
50
|
-
|
|
51
|
-
### getX()
|
|
52
|
-
- getX(): [Number](TopLevel.Number.md)
|
|
53
|
-
- : Returns the focal point abscissa.
|
|
54
|
-
|
|
55
|
-
**Returns:**
|
|
56
|
-
- the focal point abscissa
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
### getY()
|
|
62
|
-
- getY(): [Number](TopLevel.Number.md)
|
|
63
|
-
- : Returns the focal point ordinate.
|
|
64
|
-
|
|
65
|
-
**Returns:**
|
|
66
|
-
- the focal point ordinate
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Image
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.experience.image.Image](dw.experience.image.Image.md)
|
|
6
|
-
|
|
7
|
-
This class represents an image with additional configuration capabilities (e.g. optional focal point).
|
|
8
|
-
Furthermore it provides access to meta data of the referenced image file.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
**See Also:**
|
|
12
|
-
- [FocalPoint](dw.experience.image.FocalPoint.md)
|
|
13
|
-
- [ImageMetaData](dw.experience.image.ImageMetaData.md)
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
## Property Summary
|
|
17
|
-
|
|
18
|
-
| Property | Description |
|
|
19
|
-
| --- | --- |
|
|
20
|
-
| [file](#file): [MediaFile](dw.content.MediaFile.md) `(read-only)` | Returns the image media file from the current site's library. |
|
|
21
|
-
| [focalPoint](#focalpoint): [FocalPoint](dw.experience.image.FocalPoint.md) `(read-only)` | Returns the focal point of the image. |
|
|
22
|
-
| [metaData](#metadata): [ImageMetaData](dw.experience.image.ImageMetaData.md) `(read-only)` | Returns the meta data of the physical image file. |
|
|
23
|
-
|
|
24
|
-
## Constructor Summary
|
|
25
|
-
|
|
26
|
-
This class does not have a constructor, so you cannot create it directly.
|
|
27
|
-
## Method Summary
|
|
28
|
-
|
|
29
|
-
| Method | Description |
|
|
30
|
-
| --- | --- |
|
|
31
|
-
| [getFile](dw.experience.image.Image.md#getfile)() | Returns the image media file from the current site's library. |
|
|
32
|
-
| [getFocalPoint](dw.experience.image.Image.md#getfocalpoint)() | Returns the focal point of the image. |
|
|
33
|
-
| [getMetaData](dw.experience.image.Image.md#getmetadata)() | Returns the meta data of the physical image file. |
|
|
34
|
-
|
|
35
|
-
### Methods inherited from class Object
|
|
36
|
-
|
|
37
|
-
[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)
|
|
38
|
-
## Property Details
|
|
39
|
-
|
|
40
|
-
### file
|
|
41
|
-
- file: [MediaFile](dw.content.MediaFile.md) `(read-only)`
|
|
42
|
-
- : Returns the image media file from the current site's library.
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
### focalPoint
|
|
48
|
-
- focalPoint: [FocalPoint](dw.experience.image.FocalPoint.md) `(read-only)`
|
|
49
|
-
- : Returns the focal point of the image.
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
### metaData
|
|
55
|
-
- metaData: [ImageMetaData](dw.experience.image.ImageMetaData.md) `(read-only)`
|
|
56
|
-
- : Returns the meta data of the physical image file. This meta data is obtained when
|
|
57
|
-
the respective component attribute was saved from Page Designer, i.e. the underlying
|
|
58
|
-
image is not queried for the meta data every time [getMetaData()](dw.experience.image.Image.md#getmetadata) is called
|
|
59
|
-
but only on store of the related component attribute.
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
---
|
|
64
|
-
|
|
65
|
-
## Method Details
|
|
66
|
-
|
|
67
|
-
### getFile()
|
|
68
|
-
- getFile(): [MediaFile](dw.content.MediaFile.md)
|
|
69
|
-
- : Returns the image media file from the current site's library.
|
|
70
|
-
|
|
71
|
-
**Returns:**
|
|
72
|
-
- the image media file, or null if not found
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
### getFocalPoint()
|
|
78
|
-
- getFocalPoint(): [FocalPoint](dw.experience.image.FocalPoint.md)
|
|
79
|
-
- : Returns the focal point of the image.
|
|
80
|
-
|
|
81
|
-
**Returns:**
|
|
82
|
-
- the focal point, or null if not found
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
### getMetaData()
|
|
88
|
-
- getMetaData(): [ImageMetaData](dw.experience.image.ImageMetaData.md)
|
|
89
|
-
- : Returns the meta data of the physical image file. This meta data is obtained when
|
|
90
|
-
the respective component attribute was saved from Page Designer, i.e. the underlying
|
|
91
|
-
image is not queried for the meta data every time [getMetaData()](dw.experience.image.Image.md#getmetadata) is called
|
|
92
|
-
but only on store of the related component attribute.
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
**Returns:**
|
|
96
|
-
- the meta data of the image, or null if no meta data was provided with the respective component attribute
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,71 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class ImageMetaData
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.experience.image.ImageMetaData](dw.experience.image.ImageMetaData.md)
|
|
6
|
-
|
|
7
|
-
This class represents the image meta data, e.g. width and height.
|
|
8
|
-
|
|
9
|
-
**See Also:**
|
|
10
|
-
- [Image](dw.experience.image.Image.md)
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## Property Summary
|
|
14
|
-
|
|
15
|
-
| Property | Description |
|
|
16
|
-
| --- | --- |
|
|
17
|
-
| [height](#height): [Number](TopLevel.Number.md) `(read-only)` | Returns the image height. |
|
|
18
|
-
| [width](#width): [Number](TopLevel.Number.md) `(read-only)` | Returns the image width. |
|
|
19
|
-
|
|
20
|
-
## Constructor Summary
|
|
21
|
-
|
|
22
|
-
This class does not have a constructor, so you cannot create it directly.
|
|
23
|
-
## Method Summary
|
|
24
|
-
|
|
25
|
-
| Method | Description |
|
|
26
|
-
| --- | --- |
|
|
27
|
-
| [getHeight](dw.experience.image.ImageMetaData.md#getheight)() | Returns the image height. |
|
|
28
|
-
| [getWidth](dw.experience.image.ImageMetaData.md#getwidth)() | Returns the image width. |
|
|
29
|
-
|
|
30
|
-
### Methods inherited from class Object
|
|
31
|
-
|
|
32
|
-
[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)
|
|
33
|
-
## Property Details
|
|
34
|
-
|
|
35
|
-
### height
|
|
36
|
-
- height: [Number](TopLevel.Number.md) `(read-only)`
|
|
37
|
-
- : Returns the image height.
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
---
|
|
41
|
-
|
|
42
|
-
### width
|
|
43
|
-
- width: [Number](TopLevel.Number.md) `(read-only)`
|
|
44
|
-
- : Returns the image width.
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
## Method Details
|
|
50
|
-
|
|
51
|
-
### getHeight()
|
|
52
|
-
- getHeight(): [Number](TopLevel.Number.md)
|
|
53
|
-
- : Returns the image height.
|
|
54
|
-
|
|
55
|
-
**Returns:**
|
|
56
|
-
- the image height in pixel
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
---
|
|
60
|
-
|
|
61
|
-
### getWidth()
|
|
62
|
-
- getWidth(): [Number](TopLevel.Number.md)
|
|
63
|
-
- : Returns the image width.
|
|
64
|
-
|
|
65
|
-
**Returns:**
|
|
66
|
-
- the image width in pixel
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
---
|
|
70
|
-
|
|
71
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
# Package dw.experience.image
|
|
2
|
-
|
|
3
|
-
## Classes
|
|
4
|
-
| Class | Description |
|
|
5
|
-
| --- | --- |
|
|
6
|
-
| [FocalPoint](dw.experience.image.FocalPoint.md) | This class represents an image focal point. |
|
|
7
|
-
| [Image](dw.experience.image.Image.md) | This class represents an image with additional configuration capabilities (e.g. |
|
|
8
|
-
| [ImageMetaData](dw.experience.image.ImageMetaData.md) | This class represents the image meta data, e.g. |
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
# Package dw.experience
|
|
2
|
-
|
|
3
|
-
## Classes
|
|
4
|
-
| Class | Description |
|
|
5
|
-
| --- | --- |
|
|
6
|
-
| [AspectAttributeValidationException](dw.experience.AspectAttributeValidationException.md) | This APIException is thrown by method [PageMgr.renderPage(String, Map, String)](dw.experience.PageMgr.md#renderpagestring-map-string) and [PageMgr.serializePage(String, Map, String)](dw.experience.PageMgr.md#serializepagestring-map-string) to indicate that the passed aspect attributes failed during validation against the definition provided through the aspect type of the page. |
|
|
7
|
-
| [Component](dw.experience.Component.md) | This class represents a page designer managed component as part of a page. |
|
|
8
|
-
| [ComponentRenderSettings](dw.experience.ComponentRenderSettings.md) | A config that drives how the component is rendered. |
|
|
9
|
-
| [ComponentScriptContext](dw.experience.ComponentScriptContext.md) | This is the context that is handed over to the `render` and `serialize` function of the respective component type script. |
|
|
10
|
-
| [CustomEditor](dw.experience.CustomEditor.md) | This class represents a custom editor for component attributes of type `custom`. |
|
|
11
|
-
| [CustomEditorResources](dw.experience.CustomEditorResources.md) | This class represents the resources of a custom editor, i.e. |
|
|
12
|
-
| [Page](dw.experience.Page.md) | <p> This class represents a page designer managed page. |
|
|
13
|
-
| [PageMgr](dw.experience.PageMgr.md) | Provides functionality for getting, rendering and serializing page designer managed pages. |
|
|
14
|
-
| [PageScriptContext](dw.experience.PageScriptContext.md) | This is the context that is handed over to the `render` and `serialize` function of the respective page type script. |
|
|
15
|
-
| [Region](dw.experience.Region.md) | This class represents a region which serves as container of components. |
|
|
16
|
-
| [RegionRenderSettings](dw.experience.RegionRenderSettings.md) | A config that drives how the region is rendered. |
|
|
@@ -1,254 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class ApplePayHookResult
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.extensions.applepay.ApplePayHookResult](dw.extensions.applepay.ApplePayHookResult.md)
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
Result of a hook handling an Apple Pay request.
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
Use the constants in this type to indicate specific error reasons to be provided
|
|
16
|
-
to Apple Pay JS. For example, the following code creates a [Status](dw.system.Status.md)
|
|
17
|
-
that indicates the shipping contact information provided by Apple Pay is invalid:
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
```
|
|
23
|
-
var ApplePayHookResult = require('dw/extensions/applepay/ApplePayHookResult');
|
|
24
|
-
var Status = require('dw/system/Status');
|
|
25
|
-
|
|
26
|
-
var error = new Status(Status.ERROR);
|
|
27
|
-
error.addDetail(ApplePayHookResult.STATUS_REASON_DETAIL_KEY, ApplePayHookResult.REASON_SHIPPING_CONTACT);
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
If a specific error reason is not provided, the generic Apple Pay `STATUS_FAILURE`
|
|
34
|
-
reason will be used when necessary.
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
## Constant Summary
|
|
39
|
-
|
|
40
|
-
| Constant | Description |
|
|
41
|
-
| --- | --- |
|
|
42
|
-
| [REASON_BILLING_ADDRESS](#reason_billing_address): [String](TopLevel.String.md) = "InvalidBillingPostalAddress" | Error reason code representing an invalid billing address. |
|
|
43
|
-
| [REASON_FAILURE](#reason_failure): [String](TopLevel.String.md) = "Failure" | Error reason code representing an error or failure not otherwise specified. |
|
|
44
|
-
| [REASON_PIN_INCORRECT](#reason_pin_incorrect): [String](TopLevel.String.md) = "PINIncorrect" | Error reason code representing the PIN is incorrect. |
|
|
45
|
-
| [REASON_PIN_LOCKOUT](#reason_pin_lockout): [String](TopLevel.String.md) = "PINLockout" | Error reason code representing a PIN lockout. |
|
|
46
|
-
| [REASON_PIN_REQUIRED](#reason_pin_required): [String](TopLevel.String.md) = "PINRequired" | Error reason code representing a PIN is required. |
|
|
47
|
-
| [REASON_SHIPPING_ADDRESS](#reason_shipping_address): [String](TopLevel.String.md) = "InvalidShippingPostalAddress" | Error reason code representing an invalid shipping address. |
|
|
48
|
-
| [REASON_SHIPPING_CONTACT](#reason_shipping_contact): [String](TopLevel.String.md) = "InvalidShippingContact" | Error reason code representing invalid shipping contact information. |
|
|
49
|
-
| [STATUS_REASON_DETAIL_KEY](#status_reason_detail_key): [String](TopLevel.String.md) = "reason" | Key for the detail to be used in [Status](dw.system.Status.md) objects to indicate the reason to communicate to Apple Pay for errors. |
|
|
50
|
-
|
|
51
|
-
## Property Summary
|
|
52
|
-
|
|
53
|
-
| Property | Description |
|
|
54
|
-
| --- | --- |
|
|
55
|
-
| [eventDetail](#eventdetail): [Object](TopLevel.Object.md) `(read-only)` | Detail to the JS custom event to dispatch in response to this result. |
|
|
56
|
-
| [eventName](#eventname): [String](TopLevel.String.md) `(read-only)` | Name of the JS custom event to dispatch in response to this result. |
|
|
57
|
-
| [redirect](#redirect): [URL](dw.web.URL.md) `(read-only)` | URL to navigate to in response to this result. |
|
|
58
|
-
| [status](#status): [Status](dw.system.Status.md) `(read-only)` | Status describing the outcome of this result. |
|
|
59
|
-
|
|
60
|
-
## Constructor Summary
|
|
61
|
-
|
|
62
|
-
| Constructor | Description |
|
|
63
|
-
| --- | --- |
|
|
64
|
-
| [ApplePayHookResult](#applepayhookresultstatus-url)([Status](dw.system.Status.md), [URL](dw.web.URL.md)) | Constructs a result with the given outcome information. |
|
|
65
|
-
|
|
66
|
-
## Method Summary
|
|
67
|
-
|
|
68
|
-
| Method | Description |
|
|
69
|
-
| --- | --- |
|
|
70
|
-
| [getEventDetail](dw.extensions.applepay.ApplePayHookResult.md#geteventdetail)() | Detail to the JS custom event to dispatch in response to this result. |
|
|
71
|
-
| [getEventName](dw.extensions.applepay.ApplePayHookResult.md#geteventname)() | Name of the JS custom event to dispatch in response to this result. |
|
|
72
|
-
| [getRedirect](dw.extensions.applepay.ApplePayHookResult.md#getredirect)() | URL to navigate to in response to this result. |
|
|
73
|
-
| [getStatus](dw.extensions.applepay.ApplePayHookResult.md#getstatus)() | Status describing the outcome of this result. |
|
|
74
|
-
| [setEvent](dw.extensions.applepay.ApplePayHookResult.md#seteventstring)([String](TopLevel.String.md)) | Sets the name of the JS custom event to dispatch in response to this result. |
|
|
75
|
-
| [setEvent](dw.extensions.applepay.ApplePayHookResult.md#seteventstring-object)([String](TopLevel.String.md), [Object](TopLevel.Object.md)) | Sets the name and detail of the JS custom event to dispatch in response to this result. |
|
|
76
|
-
|
|
77
|
-
### Methods inherited from class Object
|
|
78
|
-
|
|
79
|
-
[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)
|
|
80
|
-
## Constant Details
|
|
81
|
-
|
|
82
|
-
### REASON_BILLING_ADDRESS
|
|
83
|
-
|
|
84
|
-
- REASON_BILLING_ADDRESS: [String](TopLevel.String.md) = "InvalidBillingPostalAddress"
|
|
85
|
-
- : Error reason code representing an invalid billing address.
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
### REASON_FAILURE
|
|
91
|
-
|
|
92
|
-
- REASON_FAILURE: [String](TopLevel.String.md) = "Failure"
|
|
93
|
-
- : Error reason code representing an error or failure not otherwise specified.
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
---
|
|
97
|
-
|
|
98
|
-
### REASON_PIN_INCORRECT
|
|
99
|
-
|
|
100
|
-
- REASON_PIN_INCORRECT: [String](TopLevel.String.md) = "PINIncorrect"
|
|
101
|
-
- : Error reason code representing the PIN is incorrect.
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
---
|
|
105
|
-
|
|
106
|
-
### REASON_PIN_LOCKOUT
|
|
107
|
-
|
|
108
|
-
- REASON_PIN_LOCKOUT: [String](TopLevel.String.md) = "PINLockout"
|
|
109
|
-
- : Error reason code representing a PIN lockout.
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
---
|
|
113
|
-
|
|
114
|
-
### REASON_PIN_REQUIRED
|
|
115
|
-
|
|
116
|
-
- REASON_PIN_REQUIRED: [String](TopLevel.String.md) = "PINRequired"
|
|
117
|
-
- : Error reason code representing a PIN is required.
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
### REASON_SHIPPING_ADDRESS
|
|
123
|
-
|
|
124
|
-
- REASON_SHIPPING_ADDRESS: [String](TopLevel.String.md) = "InvalidShippingPostalAddress"
|
|
125
|
-
- : Error reason code representing an invalid shipping address.
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
### REASON_SHIPPING_CONTACT
|
|
131
|
-
|
|
132
|
-
- REASON_SHIPPING_CONTACT: [String](TopLevel.String.md) = "InvalidShippingContact"
|
|
133
|
-
- : Error reason code representing invalid shipping contact information.
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
---
|
|
137
|
-
|
|
138
|
-
### STATUS_REASON_DETAIL_KEY
|
|
139
|
-
|
|
140
|
-
- STATUS_REASON_DETAIL_KEY: [String](TopLevel.String.md) = "reason"
|
|
141
|
-
- : Key for the detail to be used in [Status](dw.system.Status.md) objects to indicate
|
|
142
|
-
the reason to communicate to Apple Pay for errors.
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
---
|
|
147
|
-
|
|
148
|
-
## Property Details
|
|
149
|
-
|
|
150
|
-
### eventDetail
|
|
151
|
-
- eventDetail: [Object](TopLevel.Object.md) `(read-only)`
|
|
152
|
-
- : Detail to the JS custom event to dispatch in response to this result.
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
---
|
|
156
|
-
|
|
157
|
-
### eventName
|
|
158
|
-
- eventName: [String](TopLevel.String.md) `(read-only)`
|
|
159
|
-
- : Name of the JS custom event to dispatch in response to this result.
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
---
|
|
163
|
-
|
|
164
|
-
### redirect
|
|
165
|
-
- redirect: [URL](dw.web.URL.md) `(read-only)`
|
|
166
|
-
- : URL to navigate to in response to this result.
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
---
|
|
170
|
-
|
|
171
|
-
### status
|
|
172
|
-
- status: [Status](dw.system.Status.md) `(read-only)`
|
|
173
|
-
- : Status describing the outcome of this result.
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
---
|
|
177
|
-
|
|
178
|
-
## Constructor Details
|
|
179
|
-
|
|
180
|
-
### ApplePayHookResult(Status, URL)
|
|
181
|
-
- ApplePayHookResult(status: [Status](dw.system.Status.md), redirect: [URL](dw.web.URL.md))
|
|
182
|
-
- : Constructs a result with the given outcome information.
|
|
183
|
-
|
|
184
|
-
**Parameters:**
|
|
185
|
-
- status - status of the result
|
|
186
|
-
- redirect - optional URL to which to navigate to in response to this outcome
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
---
|
|
190
|
-
|
|
191
|
-
## Method Details
|
|
192
|
-
|
|
193
|
-
### getEventDetail()
|
|
194
|
-
- getEventDetail(): [Object](TopLevel.Object.md)
|
|
195
|
-
- : Detail to the JS custom event to dispatch in response to this result.
|
|
196
|
-
|
|
197
|
-
**Returns:**
|
|
198
|
-
- event detail
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
---
|
|
202
|
-
|
|
203
|
-
### getEventName()
|
|
204
|
-
- getEventName(): [String](TopLevel.String.md)
|
|
205
|
-
- : Name of the JS custom event to dispatch in response to this result.
|
|
206
|
-
|
|
207
|
-
**Returns:**
|
|
208
|
-
- event name
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
---
|
|
212
|
-
|
|
213
|
-
### getRedirect()
|
|
214
|
-
- getRedirect(): [URL](dw.web.URL.md)
|
|
215
|
-
- : URL to navigate to in response to this result.
|
|
216
|
-
|
|
217
|
-
**Returns:**
|
|
218
|
-
- redirect URL
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
---
|
|
222
|
-
|
|
223
|
-
### getStatus()
|
|
224
|
-
- getStatus(): [Status](dw.system.Status.md)
|
|
225
|
-
- : Status describing the outcome of this result.
|
|
226
|
-
|
|
227
|
-
**Returns:**
|
|
228
|
-
- status of this result
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
---
|
|
232
|
-
|
|
233
|
-
### setEvent(String)
|
|
234
|
-
- setEvent(name: [String](TopLevel.String.md)): void
|
|
235
|
-
- : Sets the name of the JS custom event to dispatch in response to this result.
|
|
236
|
-
|
|
237
|
-
**Parameters:**
|
|
238
|
-
- name - JS custom event name
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
---
|
|
242
|
-
|
|
243
|
-
### setEvent(String, Object)
|
|
244
|
-
- setEvent(name: [String](TopLevel.String.md), detail: [Object](TopLevel.Object.md)): void
|
|
245
|
-
- : Sets the name and detail of the JS custom event to dispatch in response to this result.
|
|
246
|
-
|
|
247
|
-
**Parameters:**
|
|
248
|
-
- name - JS custom event name
|
|
249
|
-
- detail - JS custom event detail
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
---
|
|
253
|
-
|
|
254
|
-
<!-- prettier-ignore-end -->
|