@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.
- 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/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/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,59 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Cookies
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.web.Cookies](dw.web.Cookies.md)
|
|
6
|
-
|
|
7
|
-
The class provides an index and associative array like access to the Cookies
|
|
8
|
-
of the current request. Cookies can be retrieved by calling
|
|
9
|
-
dw.system.Request.getHttpCookies().
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
**Note:** this class allows access to sensitive security-related data.
|
|
13
|
-
Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
See [Request.getHttpCookies()](dw.system.Request.md#gethttpcookies).
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
## Property Summary
|
|
21
|
-
|
|
22
|
-
| Property | Description |
|
|
23
|
-
| --- | --- |
|
|
24
|
-
| [cookieCount](#cookiecount): [Number](TopLevel.Number.md) `(read-only)` | Returns the number of known cookies. |
|
|
25
|
-
|
|
26
|
-
## Constructor Summary
|
|
27
|
-
|
|
28
|
-
This class does not have a constructor, so you cannot create it directly.
|
|
29
|
-
## Method Summary
|
|
30
|
-
|
|
31
|
-
| Method | Description |
|
|
32
|
-
| --- | --- |
|
|
33
|
-
| [getCookieCount](dw.web.Cookies.md#getcookiecount)() | Returns the number of known cookies. |
|
|
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
|
-
### cookieCount
|
|
41
|
-
- cookieCount: [Number](TopLevel.Number.md) `(read-only)`
|
|
42
|
-
- : Returns the number of known cookies.
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
## Method Details
|
|
48
|
-
|
|
49
|
-
### getCookieCount()
|
|
50
|
-
- getCookieCount(): [Number](TopLevel.Number.md)
|
|
51
|
-
- : Returns the number of known cookies.
|
|
52
|
-
|
|
53
|
-
**Returns:**
|
|
54
|
-
- the number of cookies
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
---
|
|
58
|
-
|
|
59
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,84 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Form
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.web.FormElement](dw.web.FormElement.md)
|
|
6
|
-
- [dw.web.FormGroup](dw.web.FormGroup.md)
|
|
7
|
-
- [dw.web.Form](dw.web.Form.md)
|
|
8
|
-
|
|
9
|
-
The class is the top level element in the form instance hierachy.
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
## Property Summary
|
|
13
|
-
|
|
14
|
-
| Property | Description |
|
|
15
|
-
| --- | --- |
|
|
16
|
-
| [secureKeyHtmlName](#securekeyhtmlname): [String](TopLevel.String.md) `(read-only)` | Returns the secure key html name to be used for the hidden input field that will contain the secure key value. |
|
|
17
|
-
| [secureKeyValue](#securekeyvalue): [String](TopLevel.String.md) `(read-only)` | Returns the secure key value that is generated for the form to use in a hidden input field for authentication. |
|
|
18
|
-
|
|
19
|
-
## Constructor Summary
|
|
20
|
-
|
|
21
|
-
This class does not have a constructor, so you cannot create it directly.
|
|
22
|
-
## Method Summary
|
|
23
|
-
|
|
24
|
-
| Method | Description |
|
|
25
|
-
| --- | --- |
|
|
26
|
-
| [getSecureKeyHtmlName](dw.web.Form.md#getsecurekeyhtmlname)() | Returns the secure key html name to be used for the hidden input field that will contain the secure key value. |
|
|
27
|
-
| [getSecureKeyValue](dw.web.Form.md#getsecurekeyvalue)() | Returns the secure key value that is generated for the form to use in a hidden input field for authentication. |
|
|
28
|
-
|
|
29
|
-
### Methods inherited from class FormGroup
|
|
30
|
-
|
|
31
|
-
[accept](dw.web.FormGroup.md#accept), [copyFrom](dw.web.FormGroup.md#copyfromobject), [copyTo](dw.web.FormGroup.md#copytoobject), [getChildCount](dw.web.FormGroup.md#getchildcount), [getError](dw.web.FormGroup.md#geterror), [getObject](dw.web.FormGroup.md#getobject), [getSubmittedAction](dw.web.FormGroup.md#getsubmittedaction), [getTriggeredAction](dw.web.FormGroup.md#gettriggeredaction)
|
|
32
|
-
### Methods inherited from class FormElement
|
|
33
|
-
|
|
34
|
-
[clearFormElement](dw.web.FormElement.md#clearformelement), [getDynamicHtmlName](dw.web.FormElement.md#getdynamichtmlname), [getFormId](dw.web.FormElement.md#getformid), [getHtmlName](dw.web.FormElement.md#gethtmlname), [getParent](dw.web.FormElement.md#getparent), [getValidationResult](dw.web.FormElement.md#getvalidationresult), [invalidateFormElement](dw.web.FormElement.md#invalidateformelement), [invalidateFormElement](dw.web.FormElement.md#invalidateformelementstring), [isValid](dw.web.FormElement.md#isvalid)
|
|
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
|
-
### secureKeyHtmlName
|
|
41
|
-
- secureKeyHtmlName: [String](TopLevel.String.md) `(read-only)`
|
|
42
|
-
- : Returns the secure key html name to be used for the hidden input field
|
|
43
|
-
that will contain the secure key value.
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
---
|
|
48
|
-
|
|
49
|
-
### secureKeyValue
|
|
50
|
-
- secureKeyValue: [String](TopLevel.String.md) `(read-only)`
|
|
51
|
-
- : Returns the secure key value that is generated for the form to use
|
|
52
|
-
in a hidden input field for authentication.
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## Method Details
|
|
59
|
-
|
|
60
|
-
### getSecureKeyHtmlName()
|
|
61
|
-
- getSecureKeyHtmlName(): [String](TopLevel.String.md)
|
|
62
|
-
- : Returns the secure key html name to be used for the hidden input field
|
|
63
|
-
that will contain the secure key value.
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
**Returns:**
|
|
67
|
-
- the secure key html name
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
---
|
|
71
|
-
|
|
72
|
-
### getSecureKeyValue()
|
|
73
|
-
- getSecureKeyValue(): [String](TopLevel.String.md)
|
|
74
|
-
- : Returns the secure key value that is generated for the form to use
|
|
75
|
-
in a hidden input field for authentication.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
**Returns:**
|
|
79
|
-
- the secure key value
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,195 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class FormAction
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.web.FormElement](dw.web.FormElement.md)
|
|
6
|
-
- [dw.web.FormAction](dw.web.FormAction.md)
|
|
7
|
-
|
|
8
|
-
The FormAction class represents the action in form instance hierarchy.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
## Property Summary
|
|
12
|
-
|
|
13
|
-
| Property | Description |
|
|
14
|
-
| --- | --- |
|
|
15
|
-
| [description](#description): [String](TopLevel.String.md) `(read-only)` | Returns the optional description for the action. |
|
|
16
|
-
| [label](#label): [String](TopLevel.String.md) `(read-only)` | Returns the optional label for the action. |
|
|
17
|
-
| [object](#object): [Object](TopLevel.Object.md) `(read-only)` | Returns the object that was bound to the form in which the action is contained. |
|
|
18
|
-
| [submitted](#submitted): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if the form action was submitted from the client to the server. |
|
|
19
|
-
| [triggered](#triggered): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies that this action is triggerd. |
|
|
20
|
-
| [x](#x): [Number](TopLevel.Number.md) `(read-only)` | In case of an image button, returns the x coordinate of the last click. |
|
|
21
|
-
| [y](#y): [Number](TopLevel.Number.md) `(read-only)` | In case of an image button, returns the y coordinate of the last click. |
|
|
22
|
-
|
|
23
|
-
## Constructor Summary
|
|
24
|
-
|
|
25
|
-
This class does not have a constructor, so you cannot create it directly.
|
|
26
|
-
## Method Summary
|
|
27
|
-
|
|
28
|
-
| Method | Description |
|
|
29
|
-
| --- | --- |
|
|
30
|
-
| [getDescription](dw.web.FormAction.md#getdescription)() | Returns the optional description for the action. |
|
|
31
|
-
| [getLabel](dw.web.FormAction.md#getlabel)() | Returns the optional label for the action. |
|
|
32
|
-
| [getObject](dw.web.FormAction.md#getobject)() | Returns the object that was bound to the form in which the action is contained. |
|
|
33
|
-
| [getX](dw.web.FormAction.md#getx)() | In case of an image button, returns the x coordinate of the last click. |
|
|
34
|
-
| [getY](dw.web.FormAction.md#gety)() | In case of an image button, returns the y coordinate of the last click. |
|
|
35
|
-
| [isSubmitted](dw.web.FormAction.md#issubmitted)() | Identifies if the form action was submitted from the client to the server. |
|
|
36
|
-
| [isTriggered](dw.web.FormAction.md#istriggered)() | Identifies that this action is triggerd. |
|
|
37
|
-
|
|
38
|
-
### Methods inherited from class FormElement
|
|
39
|
-
|
|
40
|
-
[clearFormElement](dw.web.FormElement.md#clearformelement), [getDynamicHtmlName](dw.web.FormElement.md#getdynamichtmlname), [getFormId](dw.web.FormElement.md#getformid), [getHtmlName](dw.web.FormElement.md#gethtmlname), [getParent](dw.web.FormElement.md#getparent), [getValidationResult](dw.web.FormElement.md#getvalidationresult), [invalidateFormElement](dw.web.FormElement.md#invalidateformelement), [invalidateFormElement](dw.web.FormElement.md#invalidateformelementstring), [isValid](dw.web.FormElement.md#isvalid)
|
|
41
|
-
### Methods inherited from class Object
|
|
42
|
-
|
|
43
|
-
[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)
|
|
44
|
-
## Property Details
|
|
45
|
-
|
|
46
|
-
### description
|
|
47
|
-
- description: [String](TopLevel.String.md) `(read-only)`
|
|
48
|
-
- : Returns the optional description for the action. The description could be used
|
|
49
|
-
as tooltip for the action.
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
### label
|
|
56
|
-
- label: [String](TopLevel.String.md) `(read-only)`
|
|
57
|
-
- : Returns the optional label for the action. The label would be typically used
|
|
58
|
-
as button text.
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
### object
|
|
65
|
-
- object: [Object](TopLevel.Object.md) `(read-only)`
|
|
66
|
-
- : Returns the object that was bound to the form in which the action
|
|
67
|
-
is contained. The method is a convenience method for getParent().getObject().
|
|
68
|
-
In most cases this is actually the object for which
|
|
69
|
-
the specific action is triggered.
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
### submitted
|
|
76
|
-
- submitted: [Boolean](TopLevel.Boolean.md) `(read-only)`
|
|
77
|
-
- : Identifies if the form action was submitted from
|
|
78
|
-
the client to the server.
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
### triggered
|
|
85
|
-
- triggered: [Boolean](TopLevel.Boolean.md) `(read-only)`
|
|
86
|
-
- : Identifies that this action is triggerd. An
|
|
87
|
-
action is only triggered if it was submitted and the constraints, regarding
|
|
88
|
-
a valid form, are met.
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
---
|
|
93
|
-
|
|
94
|
-
### x
|
|
95
|
-
- x: [Number](TopLevel.Number.md) `(read-only)`
|
|
96
|
-
- : In case of an image button, returns the x coordinate of the last click.
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
---
|
|
100
|
-
|
|
101
|
-
### y
|
|
102
|
-
- y: [Number](TopLevel.Number.md) `(read-only)`
|
|
103
|
-
- : In case of an image button, returns the y coordinate of the last click.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
---
|
|
107
|
-
|
|
108
|
-
## Method Details
|
|
109
|
-
|
|
110
|
-
### getDescription()
|
|
111
|
-
- getDescription(): [String](TopLevel.String.md)
|
|
112
|
-
- : Returns the optional description for the action. The description could be used
|
|
113
|
-
as tooltip for the action.
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
**Returns:**
|
|
117
|
-
- the optional description for the action.
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
### getLabel()
|
|
123
|
-
- getLabel(): [String](TopLevel.String.md)
|
|
124
|
-
- : Returns the optional label for the action. The label would be typically used
|
|
125
|
-
as button text.
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
**Returns:**
|
|
129
|
-
- the optional label for the action.
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
---
|
|
133
|
-
|
|
134
|
-
### getObject()
|
|
135
|
-
- getObject(): [Object](TopLevel.Object.md)
|
|
136
|
-
- : Returns the object that was bound to the form in which the action
|
|
137
|
-
is contained. The method is a convenience method for getParent().getObject().
|
|
138
|
-
In most cases this is actually the object for which
|
|
139
|
-
the specific action is triggered.
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
**Returns:**
|
|
143
|
-
- the object that was bound to the form in which the action
|
|
144
|
-
is contained.
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
---
|
|
149
|
-
|
|
150
|
-
### getX()
|
|
151
|
-
- getX(): [Number](TopLevel.Number.md)
|
|
152
|
-
- : In case of an image button, returns the x coordinate of the last click.
|
|
153
|
-
|
|
154
|
-
**Returns:**
|
|
155
|
-
- the x coordinate of the last click.
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
---
|
|
159
|
-
|
|
160
|
-
### getY()
|
|
161
|
-
- getY(): [Number](TopLevel.Number.md)
|
|
162
|
-
- : In case of an image button, returns the y coordinate of the last click.
|
|
163
|
-
|
|
164
|
-
**Returns:**
|
|
165
|
-
- the y coordinate of the last click.
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
---
|
|
169
|
-
|
|
170
|
-
### isSubmitted()
|
|
171
|
-
- isSubmitted(): [Boolean](TopLevel.Boolean.md)
|
|
172
|
-
- : Identifies if the form action was submitted from
|
|
173
|
-
the client to the server.
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
**Returns:**
|
|
177
|
-
- true if the form action was submitted, false otherwise.
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
---
|
|
181
|
-
|
|
182
|
-
### isTriggered()
|
|
183
|
-
- isTriggered(): [Boolean](TopLevel.Boolean.md)
|
|
184
|
-
- : Identifies that this action is triggerd. An
|
|
185
|
-
action is only triggered if it was submitted and the constraints, regarding
|
|
186
|
-
a valid form, are met.
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
**Returns:**
|
|
190
|
-
- true if the action is triggered, false otherwise.
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
---
|
|
194
|
-
|
|
195
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,211 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class FormElement
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.web.FormElement](dw.web.FormElement.md)
|
|
6
|
-
|
|
7
|
-
Represents a form element.
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## All Known Subclasses
|
|
11
|
-
[Form](dw.web.Form.md), [FormAction](dw.web.FormAction.md), [FormField](dw.web.FormField.md), [FormGroup](dw.web.FormGroup.md), [FormList](dw.web.FormList.md), [FormListItem](dw.web.FormListItem.md)
|
|
12
|
-
## Property Summary
|
|
13
|
-
|
|
14
|
-
| Property | Description |
|
|
15
|
-
| --- | --- |
|
|
16
|
-
| [dynamicHtmlName](#dynamichtmlname): [String](TopLevel.String.md) `(read-only)` | Returns a dynamic html name for the field. |
|
|
17
|
-
| [formId](#formid): [String](TopLevel.String.md) `(read-only)` | The ID of the form element. |
|
|
18
|
-
| [htmlName](#htmlname): [String](TopLevel.String.md) `(read-only)` | Returns the global unique name of the field, which can be used as name in the html form. |
|
|
19
|
-
| [parent](#parent): [FormElement](dw.web.FormElement.md) `(read-only)` | The parent within the form. |
|
|
20
|
-
| [valid](#valid): [Boolean](TopLevel.Boolean.md) `(read-only)` | Identifies if this element and all its children elements are valid. |
|
|
21
|
-
| [validationResult](#validationresult): [FormElementValidationResult](dw.web.FormElementValidationResult.md) `(read-only)` | Provides a combined view on the validation status as per isValid() and getError(). |
|
|
22
|
-
|
|
23
|
-
## Constructor Summary
|
|
24
|
-
|
|
25
|
-
This class does not have a constructor, so you cannot create it directly.
|
|
26
|
-
## Method Summary
|
|
27
|
-
|
|
28
|
-
| Method | Description |
|
|
29
|
-
| --- | --- |
|
|
30
|
-
| [clearFormElement](dw.web.FormElement.md#clearformelement)() | This method clears the whole form. |
|
|
31
|
-
| [getDynamicHtmlName](dw.web.FormElement.md#getdynamichtmlname)() | Returns a dynamic html name for the field. |
|
|
32
|
-
| [getFormId](dw.web.FormElement.md#getformid)() | The ID of the form element. |
|
|
33
|
-
| [getHtmlName](dw.web.FormElement.md#gethtmlname)() | Returns the global unique name of the field, which can be used as name in the html form. |
|
|
34
|
-
| [getParent](dw.web.FormElement.md#getparent)() | The parent within the form. |
|
|
35
|
-
| [getValidationResult](dw.web.FormElement.md#getvalidationresult)() | Provides a combined view on the validation status as per isValid() and getError(). |
|
|
36
|
-
| [invalidateFormElement](dw.web.FormElement.md#invalidateformelement)() | The method can be called to explicitly invalidate a form element. |
|
|
37
|
-
| [invalidateFormElement](dw.web.FormElement.md#invalidateformelementstring)([String](TopLevel.String.md)) | The method can be called to explicitly invalidate a field. |
|
|
38
|
-
| [isValid](dw.web.FormElement.md#isvalid)() | Identifies if this element and all its children elements are valid. |
|
|
39
|
-
|
|
40
|
-
### Methods inherited from class Object
|
|
41
|
-
|
|
42
|
-
[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)
|
|
43
|
-
## Property Details
|
|
44
|
-
|
|
45
|
-
### dynamicHtmlName
|
|
46
|
-
- dynamicHtmlName: [String](TopLevel.String.md) `(read-only)`
|
|
47
|
-
- : Returns a dynamic html name for the field. It can be used to suppress any autocompletion
|
|
48
|
-
support from a browser, e.g. for credit card related fields. It can be also
|
|
49
|
-
used for a unique form name, if one form is used multiple times in a page.
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
### formId
|
|
56
|
-
- formId: [String](TopLevel.String.md) `(read-only)`
|
|
57
|
-
- : The ID of the form element. The is is unique within the parent
|
|
58
|
-
element of the form.
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
### htmlName
|
|
65
|
-
- htmlName: [String](TopLevel.String.md) `(read-only)`
|
|
66
|
-
- : Returns the global unique name of the field, which can be used as name
|
|
67
|
-
in the html form. For radio buttons this name is not unique.
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
---
|
|
72
|
-
|
|
73
|
-
### parent
|
|
74
|
-
- parent: [FormElement](dw.web.FormElement.md) `(read-only)`
|
|
75
|
-
- : The parent within the form.
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
---
|
|
79
|
-
|
|
80
|
-
### valid
|
|
81
|
-
- valid: [Boolean](TopLevel.Boolean.md) `(read-only)`
|
|
82
|
-
- : Identifies if this element and all its children elements are
|
|
83
|
-
valid. A form element, which was not submitted in the last
|
|
84
|
-
request is always valid.
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
### validationResult
|
|
91
|
-
- validationResult: [FormElementValidationResult](dw.web.FormElementValidationResult.md) `(read-only)`
|
|
92
|
-
- : Provides a combined view on the validation status as per isValid() and getError(). In
|
|
93
|
-
addition it also provides the data as returned by the validation in case a validation
|
|
94
|
-
script was used.
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
## Method Details
|
|
101
|
-
|
|
102
|
-
### clearFormElement()
|
|
103
|
-
- clearFormElement(): void
|
|
104
|
-
- : This method clears the whole form. After clearing a form it
|
|
105
|
-
contains no value or the default value, is not bound to any business
|
|
106
|
-
object and has the status of being valid.
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
---
|
|
111
|
-
|
|
112
|
-
### getDynamicHtmlName()
|
|
113
|
-
- getDynamicHtmlName(): [String](TopLevel.String.md)
|
|
114
|
-
- : Returns a dynamic html name for the field. It can be used to suppress any autocompletion
|
|
115
|
-
support from a browser, e.g. for credit card related fields. It can be also
|
|
116
|
-
used for a unique form name, if one form is used multiple times in a page.
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
**Returns:**
|
|
120
|
-
- a dynamic html name.
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
---
|
|
124
|
-
|
|
125
|
-
### getFormId()
|
|
126
|
-
- getFormId(): [String](TopLevel.String.md)
|
|
127
|
-
- : The ID of the form element. The is is unique within the parent
|
|
128
|
-
element of the form.
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
**Returns:**
|
|
132
|
-
- the ID of the form.
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
---
|
|
136
|
-
|
|
137
|
-
### getHtmlName()
|
|
138
|
-
- getHtmlName(): [String](TopLevel.String.md)
|
|
139
|
-
- : Returns the global unique name of the field, which can be used as name
|
|
140
|
-
in the html form. For radio buttons this name is not unique.
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
**Returns:**
|
|
144
|
-
- the global unique name of the field.
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
---
|
|
148
|
-
|
|
149
|
-
### getParent()
|
|
150
|
-
- getParent(): [FormElement](dw.web.FormElement.md)
|
|
151
|
-
- : The parent within the form.
|
|
152
|
-
|
|
153
|
-
**Returns:**
|
|
154
|
-
- the parent within the form.
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
---
|
|
158
|
-
|
|
159
|
-
### getValidationResult()
|
|
160
|
-
- getValidationResult(): [FormElementValidationResult](dw.web.FormElementValidationResult.md)
|
|
161
|
-
- : Provides a combined view on the validation status as per isValid() and getError(). In
|
|
162
|
-
addition it also provides the data as returned by the validation in case a validation
|
|
163
|
-
script was used.
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
**Returns:**
|
|
167
|
-
- the validation status (valid, error, data)
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
### invalidateFormElement()
|
|
173
|
-
- invalidateFormElement(): void
|
|
174
|
-
- : The method can be called to explicitly invalidate a form element. The
|
|
175
|
-
error text will be set to the one of two possible preconfigured custom
|
|
176
|
-
error messages associated with the form definition. The "value-error"
|
|
177
|
-
message will be used for FormField instances and "form-error" will be
|
|
178
|
-
used for FormGroup instances.
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
---
|
|
183
|
-
|
|
184
|
-
### invalidateFormElement(String)
|
|
185
|
-
- invalidateFormElement(error: [String](TopLevel.String.md)): void
|
|
186
|
-
- : The method can be called to explicitly invalidate a field. The error
|
|
187
|
-
text is set to the given error message.
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
**Parameters:**
|
|
191
|
-
- error - the error text to use.
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
### isValid()
|
|
197
|
-
- isValid(): [Boolean](TopLevel.Boolean.md)
|
|
198
|
-
- : Identifies if this element and all its children elements are
|
|
199
|
-
valid. A form element, which was not submitted in the last
|
|
200
|
-
request is always valid.
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
**Returns:**
|
|
204
|
-
- true if this element and all its children elements are valid,
|
|
205
|
-
false otherwise.
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
---
|
|
210
|
-
|
|
211
|
-
<!-- prettier-ignore-end -->
|