@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,284 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Reader
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.io.Reader](dw.io.Reader.md)
|
|
6
|
-
|
|
7
|
-
The class supports reading characters from a stream.
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
## All Known Subclasses
|
|
11
|
-
[FileReader](dw.io.FileReader.md)
|
|
12
|
-
## Property Summary
|
|
13
|
-
|
|
14
|
-
| Property | Description |
|
|
15
|
-
| --- | --- |
|
|
16
|
-
| ~~[lines](#lines): [List](dw.util.List.md)~~ `(read-only)` | The method reads the whole input stream, parses it and returns a list of strings. |
|
|
17
|
-
| ~~[string](#string): [String](TopLevel.String.md)~~ `(read-only)` | The method reads the whole input stream as one string and returns it. |
|
|
18
|
-
|
|
19
|
-
## Constructor Summary
|
|
20
|
-
|
|
21
|
-
| Constructor | Description |
|
|
22
|
-
| --- | --- |
|
|
23
|
-
| [Reader](#readerstring)([String](TopLevel.String.md)) | Creates a reader from a string. |
|
|
24
|
-
| [Reader](#readerinputstream)([InputStream](dw.io.InputStream.md)) | Create a reader from a stream using UTF-8 character encoding. |
|
|
25
|
-
| [Reader](#readerinputstream-string)([InputStream](dw.io.InputStream.md), [String](TopLevel.String.md)) | Create a reader from a stream using the specified character encoding. |
|
|
26
|
-
|
|
27
|
-
## Method Summary
|
|
28
|
-
|
|
29
|
-
| Method | Description |
|
|
30
|
-
| --- | --- |
|
|
31
|
-
| [close](dw.io.Reader.md#close)() | Closes the reader. |
|
|
32
|
-
| ~~[getLines](dw.io.Reader.md#getlines)()~~ | The method reads the whole input stream, parses it and returns a list of strings. |
|
|
33
|
-
| ~~[getString](dw.io.Reader.md#getstring)()~~ | The method reads the whole input stream as one string and returns it. |
|
|
34
|
-
| [read](dw.io.Reader.md#read)() | Reads a single character from the stream. |
|
|
35
|
-
| ~~[read](dw.io.Reader.md#readnumber)([Number](TopLevel.Number.md))~~ | Reads multiple characters from the stream as string. |
|
|
36
|
-
| [readLine](dw.io.Reader.md#readline)() | Reads the next line. |
|
|
37
|
-
| [readLines](dw.io.Reader.md#readlines)() | The method reads the whole input stream, parses it and returns a list of strings. |
|
|
38
|
-
| [readN](dw.io.Reader.md#readnnumber)([Number](TopLevel.Number.md)) | Reads n characters from the stream as string. |
|
|
39
|
-
| [readString](dw.io.Reader.md#readstring)() | The method reads the whole input stream as one string and returns it. |
|
|
40
|
-
| [ready](dw.io.Reader.md#ready)() | Identifies if this stream is ready to be read. |
|
|
41
|
-
| [skip](dw.io.Reader.md#skipnumber)([Number](TopLevel.Number.md)) | Skips the specified number of characters in the stream. |
|
|
42
|
-
|
|
43
|
-
### Methods inherited from class Object
|
|
44
|
-
|
|
45
|
-
[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
|
|
46
|
-
## Property Details
|
|
47
|
-
|
|
48
|
-
### lines
|
|
49
|
-
- ~~lines: [List](dw.util.List.md)~~ `(read-only)`
|
|
50
|
-
- : The method reads the whole input stream, parses it and returns a list of strings.
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
Using this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use
|
|
54
|
-
method [readLine()](dw.io.Reader.md#readline) and process one line at a time.
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
**Deprecated:**
|
|
58
|
-
:::warning
|
|
59
|
-
Use [readLines()](dw.io.Reader.md#readlines)
|
|
60
|
-
:::
|
|
61
|
-
|
|
62
|
-
---
|
|
63
|
-
|
|
64
|
-
### string
|
|
65
|
-
- ~~string: [String](TopLevel.String.md)~~ `(read-only)`
|
|
66
|
-
- : The method reads the whole input stream as one string and returns it.
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
Using this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory
|
|
70
|
-
condition. Instead use method [readN(Number)](dw.io.Reader.md#readnnumber).
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
**Deprecated:**
|
|
74
|
-
:::warning
|
|
75
|
-
Use [readString()](dw.io.Reader.md#readstring)
|
|
76
|
-
:::
|
|
77
|
-
|
|
78
|
-
---
|
|
79
|
-
|
|
80
|
-
## Constructor Details
|
|
81
|
-
|
|
82
|
-
### Reader(String)
|
|
83
|
-
- Reader(source: [String](TopLevel.String.md))
|
|
84
|
-
- : Creates a reader from a string.
|
|
85
|
-
|
|
86
|
-
**Parameters:**
|
|
87
|
-
- source - the source string.
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
---
|
|
91
|
-
|
|
92
|
-
### Reader(InputStream)
|
|
93
|
-
- Reader(stream: [InputStream](dw.io.InputStream.md))
|
|
94
|
-
- : Create a reader from a stream using UTF-8 character encoding.
|
|
95
|
-
|
|
96
|
-
**Parameters:**
|
|
97
|
-
- stream - the input stream to use.
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
---
|
|
101
|
-
|
|
102
|
-
### Reader(InputStream, String)
|
|
103
|
-
- Reader(stream: [InputStream](dw.io.InputStream.md), encoding: [String](TopLevel.String.md))
|
|
104
|
-
- : Create a reader from a stream using the specified character encoding.
|
|
105
|
-
|
|
106
|
-
**Parameters:**
|
|
107
|
-
- stream - the input stream to use.
|
|
108
|
-
- encoding - the encoding to use.
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
---
|
|
112
|
-
|
|
113
|
-
## Method Details
|
|
114
|
-
|
|
115
|
-
### close()
|
|
116
|
-
- close(): void
|
|
117
|
-
- : Closes the reader.
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
---
|
|
121
|
-
|
|
122
|
-
### getLines()
|
|
123
|
-
- ~~getLines(): [List](dw.util.List.md)~~
|
|
124
|
-
- : The method reads the whole input stream, parses it and returns a list of strings.
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
Using this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use
|
|
128
|
-
method [readLine()](dw.io.Reader.md#readline) and process one line at a time.
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
**Returns:**
|
|
132
|
-
- a list of strings
|
|
133
|
-
|
|
134
|
-
**Deprecated:**
|
|
135
|
-
:::warning
|
|
136
|
-
Use [readLines()](dw.io.Reader.md#readlines)
|
|
137
|
-
:::
|
|
138
|
-
|
|
139
|
-
---
|
|
140
|
-
|
|
141
|
-
### getString()
|
|
142
|
-
- ~~getString(): [String](TopLevel.String.md)~~
|
|
143
|
-
- : The method reads the whole input stream as one string and returns it.
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
Using this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory
|
|
147
|
-
condition. Instead use method [readN(Number)](dw.io.Reader.md#readnnumber).
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
**Returns:**
|
|
151
|
-
- a string, which represents the whole content of the InputStream
|
|
152
|
-
|
|
153
|
-
**Throws:**
|
|
154
|
-
- IOException - if something went wrong while reading from the underlying stream
|
|
155
|
-
|
|
156
|
-
**Deprecated:**
|
|
157
|
-
:::warning
|
|
158
|
-
Use [readString()](dw.io.Reader.md#readstring)
|
|
159
|
-
:::
|
|
160
|
-
|
|
161
|
-
---
|
|
162
|
-
|
|
163
|
-
### read()
|
|
164
|
-
- read(): [String](TopLevel.String.md)
|
|
165
|
-
- : Reads a single character from the stream. The method returns null if the end of the stream is reached.
|
|
166
|
-
|
|
167
|
-
**Returns:**
|
|
168
|
-
- a single character in a string, or null if the end of the stream is reached
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
### read(Number)
|
|
174
|
-
- ~~read(length: [Number](TopLevel.Number.md)): [String](TopLevel.String.md)~~
|
|
175
|
-
- : Reads multiple characters from the stream as string. The actual number of characters that were read can be
|
|
176
|
-
determined from the length of the returned string. If the end of the stream is reached and no more characters can
|
|
177
|
-
be read, the method exits with an exception.
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
**Parameters:**
|
|
181
|
-
- length - the number of characters to read.
|
|
182
|
-
|
|
183
|
-
**Returns:**
|
|
184
|
-
- a string whose length is controlled by the length parameter. The actual number of characters that were
|
|
185
|
-
read can be determined from the length of the returned string.
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
**Throws:**
|
|
189
|
-
- an - exception if the stream is exhausted
|
|
190
|
-
|
|
191
|
-
**Deprecated:**
|
|
192
|
-
:::warning
|
|
193
|
-
use [readN(Number)](dw.io.Reader.md#readnnumber) instead which does not throw an exception if the stream is exhausted
|
|
194
|
-
:::
|
|
195
|
-
|
|
196
|
-
---
|
|
197
|
-
|
|
198
|
-
### readLine()
|
|
199
|
-
- readLine(): [String](TopLevel.String.md)
|
|
200
|
-
- : Reads the next line.
|
|
201
|
-
|
|
202
|
-
**Returns:**
|
|
203
|
-
- A String containing the contents of the line, not including any line termination characters, or null if
|
|
204
|
-
the end of the stream has been reached.
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
---
|
|
209
|
-
|
|
210
|
-
### readLines()
|
|
211
|
-
- readLines(): [List](dw.util.List.md)
|
|
212
|
-
- : The method reads the whole input stream, parses it and returns a list of strings.
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
Using this method on large feeds is inherently unsafe and may lead to an out-of-memory condition. Instead use
|
|
216
|
-
method [readLine()](dw.io.Reader.md#readline) and process one line at a time.
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
**Returns:**
|
|
220
|
-
- a list of strings
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
---
|
|
224
|
-
|
|
225
|
-
### readN(Number)
|
|
226
|
-
- readN(n: [Number](TopLevel.Number.md)): [String](TopLevel.String.md)
|
|
227
|
-
- : Reads n characters from the stream as string. The actual number of characters that were read can be determined
|
|
228
|
-
from the length of the returned string. If the end of the stream is reached and no more characters can be read,
|
|
229
|
-
the method returns null.
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
**Parameters:**
|
|
233
|
-
- n - the number of characters to read
|
|
234
|
-
|
|
235
|
-
**Returns:**
|
|
236
|
-
- a string whose maximum length is controlled by the n parameter, or null if the end of the stream is
|
|
237
|
-
reached and no more characters can be read
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
---
|
|
242
|
-
|
|
243
|
-
### readString()
|
|
244
|
-
- readString(): [String](TopLevel.String.md)
|
|
245
|
-
- : The method reads the whole input stream as one string and returns it.
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
Using this method is unsafe if the length of the input stream is not known and may lead to an out-of-memory
|
|
249
|
-
condition. Instead use method [readN(Number)](dw.io.Reader.md#readnnumber).
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
**Returns:**
|
|
253
|
-
- a string, which represents the whole content of the InputStream
|
|
254
|
-
|
|
255
|
-
**Throws:**
|
|
256
|
-
- IOException - if something went wrong while reading from the underlying stream
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
---
|
|
260
|
-
|
|
261
|
-
### ready()
|
|
262
|
-
- ready(): [Boolean](TopLevel.Boolean.md)
|
|
263
|
-
- : Identifies if this stream is ready to be read.
|
|
264
|
-
|
|
265
|
-
**Returns:**
|
|
266
|
-
- true guarantees that the stream is ready to read without waiting for input. A false
|
|
267
|
-
response means that the stream may or may not block to wait for input. Note that returning
|
|
268
|
-
false does not guarantee that the next read() will block.
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
---
|
|
273
|
-
|
|
274
|
-
### skip(Number)
|
|
275
|
-
- skip(n: [Number](TopLevel.Number.md)): void
|
|
276
|
-
- : Skips the specified number of characters in the stream.
|
|
277
|
-
|
|
278
|
-
**Parameters:**
|
|
279
|
-
- n - the number of characters to skip.
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
---
|
|
283
|
-
|
|
284
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class StringWriter
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.io.Writer](dw.io.Writer.md)
|
|
6
|
-
- [dw.io.StringWriter](dw.io.StringWriter.md)
|
|
7
|
-
|
|
8
|
-
A Writer that can be used to generate a String.
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
In most cases it is not necessary to use StringWriter. If the final
|
|
12
|
-
destination of the output is a file, use [FileWriter](dw.io.FileWriter.md) directly.
|
|
13
|
-
This will help to reduce memory usage. If you wish to transfer a feed to a
|
|
14
|
-
remote FTP, SFTP or WebDAV server, first write the feed to the file system
|
|
15
|
-
using FileWriter and optionally [CSVStreamWriter](dw.io.CSVStreamWriter.md) or
|
|
16
|
-
[XMLStreamWriter](dw.io.XMLStreamWriter.md), then upload the file with
|
|
17
|
-
[FTPClient.putBinary(String, File)](dw.net.FTPClient.md#putbinarystring-file),
|
|
18
|
-
[SFTPClient.putBinary(String, File)](dw.net.SFTPClient.md#putbinarystring-file), or
|
|
19
|
-
[WebDAVClient.put(String, File)](dw.net.WebDAVClient.md#putstring-file).
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
**Note:** when this class is used with sensitive data, be careful in persisting sensitive information to disk.
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
## Constructor Summary
|
|
27
|
-
|
|
28
|
-
| Constructor | Description |
|
|
29
|
-
| --- | --- |
|
|
30
|
-
| [StringWriter](#stringwriter)() | Creates a new StringWriter. |
|
|
31
|
-
|
|
32
|
-
## Method Summary
|
|
33
|
-
|
|
34
|
-
| Method | Description |
|
|
35
|
-
| --- | --- |
|
|
36
|
-
| [toString](dw.io.StringWriter.md#tostring)() | Returns a string representation of this writer. |
|
|
37
|
-
| [write](dw.io.StringWriter.md#writestring)([String](TopLevel.String.md)) | Write the given string to the stream. |
|
|
38
|
-
| [write](dw.io.StringWriter.md#writestring-number-number)([String](TopLevel.String.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Write the given string to the stream. |
|
|
39
|
-
|
|
40
|
-
### Methods inherited from class Writer
|
|
41
|
-
|
|
42
|
-
[close](dw.io.Writer.md#close), [flush](dw.io.Writer.md#flush), [write](dw.io.Writer.md#writestring), [write](dw.io.Writer.md#writestring-number-number)
|
|
43
|
-
### Methods inherited from class Object
|
|
44
|
-
|
|
45
|
-
[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
|
|
46
|
-
## Constructor Details
|
|
47
|
-
|
|
48
|
-
### StringWriter()
|
|
49
|
-
- StringWriter()
|
|
50
|
-
- : Creates a new StringWriter.
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## Method Details
|
|
56
|
-
|
|
57
|
-
### toString()
|
|
58
|
-
- toString(): [String](TopLevel.String.md)
|
|
59
|
-
- : Returns a string representation of this writer.
|
|
60
|
-
|
|
61
|
-
**Returns:**
|
|
62
|
-
- a string representation of this writer.
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
### write(String)
|
|
68
|
-
- write(str: [String](TopLevel.String.md)): void
|
|
69
|
-
- : Write the given string to the stream.
|
|
70
|
-
|
|
71
|
-
**Parameters:**
|
|
72
|
-
- str - the string to write to the stream.
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
---
|
|
76
|
-
|
|
77
|
-
### write(String, Number, Number)
|
|
78
|
-
- write(str: [String](TopLevel.String.md), off: [Number](TopLevel.Number.md), len: [Number](TopLevel.Number.md)): void
|
|
79
|
-
- : Write the given string to the stream.
|
|
80
|
-
|
|
81
|
-
**Parameters:**
|
|
82
|
-
- str - the string to write to the stream.
|
|
83
|
-
- off - the offset from which to start writing characters to the stream.
|
|
84
|
-
- len - the number of characters to write from the stream.
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
---
|
|
88
|
-
|
|
89
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class Writer
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.io.Writer](dw.io.Writer.md)
|
|
6
|
-
|
|
7
|
-
The class supports writing characters to a stream.
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
**Note:** when this class is used with sensitive data, be careful in persisting sensitive information to disk.
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
## All Known Subclasses
|
|
15
|
-
[FileWriter](dw.io.FileWriter.md), [PrintWriter](dw.io.PrintWriter.md), [StringWriter](dw.io.StringWriter.md)
|
|
16
|
-
## Constructor Summary
|
|
17
|
-
|
|
18
|
-
| Constructor | Description |
|
|
19
|
-
| --- | --- |
|
|
20
|
-
| [Writer](#writeroutputstream)([OutputStream](dw.io.OutputStream.md)) | Create a writer from a stream using UTF-8 character encoding. |
|
|
21
|
-
| [Writer](#writeroutputstream-string)([OutputStream](dw.io.OutputStream.md), [String](TopLevel.String.md)) | Create a writer from a stream using the specified character encoding. |
|
|
22
|
-
|
|
23
|
-
## Method Summary
|
|
24
|
-
|
|
25
|
-
| Method | Description |
|
|
26
|
-
| --- | --- |
|
|
27
|
-
| [close](dw.io.Writer.md#close)() | Closes the writer. |
|
|
28
|
-
| [flush](dw.io.Writer.md#flush)() | Flushes the buffer. |
|
|
29
|
-
| [write](dw.io.Writer.md#writestring)([String](TopLevel.String.md)) | Write the given string to the stream. |
|
|
30
|
-
| [write](dw.io.Writer.md#writestring-number-number)([String](TopLevel.String.md), [Number](TopLevel.Number.md), [Number](TopLevel.Number.md)) | Write the given string to the stream. |
|
|
31
|
-
|
|
32
|
-
### Methods inherited from class Object
|
|
33
|
-
|
|
34
|
-
[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)
|
|
35
|
-
## Constructor Details
|
|
36
|
-
|
|
37
|
-
### Writer(OutputStream)
|
|
38
|
-
- Writer(stream: [OutputStream](dw.io.OutputStream.md))
|
|
39
|
-
- : Create a writer from a stream using UTF-8 character encoding.
|
|
40
|
-
|
|
41
|
-
**Parameters:**
|
|
42
|
-
- stream - the output stream to use when creating the writer.
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
### Writer(OutputStream, String)
|
|
48
|
-
- Writer(stream: [OutputStream](dw.io.OutputStream.md), encoding: [String](TopLevel.String.md))
|
|
49
|
-
- : Create a writer from a stream using the specified character encoding.
|
|
50
|
-
|
|
51
|
-
**Parameters:**
|
|
52
|
-
- stream - the output stream to use when creating the writer.
|
|
53
|
-
- encoding - the encoding to use when creating the writer.
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
## Method Details
|
|
59
|
-
|
|
60
|
-
### close()
|
|
61
|
-
- close(): void
|
|
62
|
-
- : Closes the writer.
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
### flush()
|
|
68
|
-
- flush(): void
|
|
69
|
-
- : Flushes the buffer.
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
### write(String)
|
|
75
|
-
- write(str: [String](TopLevel.String.md)): void
|
|
76
|
-
- : Write the given string to the stream.
|
|
77
|
-
|
|
78
|
-
**Parameters:**
|
|
79
|
-
- str - the string to write to the stream.
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
### write(String, Number, Number)
|
|
85
|
-
- write(str: [String](TopLevel.String.md), off: [Number](TopLevel.Number.md), len: [Number](TopLevel.Number.md)): void
|
|
86
|
-
- : Write the given string to the stream.
|
|
87
|
-
|
|
88
|
-
**Parameters:**
|
|
89
|
-
- str - the string to write to the stream.
|
|
90
|
-
- off - the offset from which to start writing characters to the stream.
|
|
91
|
-
- len - the number of characters to write from the stream.
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
---
|
|
95
|
-
|
|
96
|
-
<!-- prettier-ignore-end -->
|
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
<!-- prettier-ignore-start -->
|
|
2
|
-
# Class XMLIndentingStreamWriter
|
|
3
|
-
|
|
4
|
-
- [TopLevel.Object](TopLevel.Object.md)
|
|
5
|
-
- [dw.io.XMLStreamWriter](dw.io.XMLStreamWriter.md)
|
|
6
|
-
- [dw.io.XMLIndentingStreamWriter](dw.io.XMLIndentingStreamWriter.md)
|
|
7
|
-
|
|
8
|
-
A XMLIndentingStreamWriter writes the XML output formatted for good
|
|
9
|
-
readability.
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
**Note:** when this class is used with sensitive data, be careful
|
|
13
|
-
in persisting sensitive information to disk.
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
## Property Summary
|
|
18
|
-
|
|
19
|
-
| Property | Description |
|
|
20
|
-
| --- | --- |
|
|
21
|
-
| [indent](#indent): [String](TopLevel.String.md) | Returns the indent. |
|
|
22
|
-
| [newLine](#newline): [String](TopLevel.String.md) | Returns the string that is used for a new line character. |
|
|
23
|
-
|
|
24
|
-
## Constructor Summary
|
|
25
|
-
|
|
26
|
-
| Constructor | Description |
|
|
27
|
-
| --- | --- |
|
|
28
|
-
| [XMLIndentingStreamWriter](#xmlindentingstreamwriterwriter)([Writer](dw.io.Writer.md)) | Constructs the writer for the specified writer. |
|
|
29
|
-
|
|
30
|
-
## Method Summary
|
|
31
|
-
|
|
32
|
-
| Method | Description |
|
|
33
|
-
| --- | --- |
|
|
34
|
-
| [getIndent](dw.io.XMLIndentingStreamWriter.md#getindent)() | Returns the indent. |
|
|
35
|
-
| [getNewLine](dw.io.XMLIndentingStreamWriter.md#getnewline)() | Returns the string that is used for a new line character. |
|
|
36
|
-
| [setIndent](dw.io.XMLIndentingStreamWriter.md#setindentstring)([String](TopLevel.String.md)) | Specifies a string that will be used as identing characters. |
|
|
37
|
-
| [setNewLine](dw.io.XMLIndentingStreamWriter.md#setnewlinestring)([String](TopLevel.String.md)) | Sets the string that is used for a new line character. |
|
|
38
|
-
|
|
39
|
-
### Methods inherited from class XMLStreamWriter
|
|
40
|
-
|
|
41
|
-
[close](dw.io.XMLStreamWriter.md#close), [flush](dw.io.XMLStreamWriter.md#flush), [getDefaultNamespace](dw.io.XMLStreamWriter.md#getdefaultnamespace), [getPrefix](dw.io.XMLStreamWriter.md#getprefixstring), [setDefaultNamespace](dw.io.XMLStreamWriter.md#setdefaultnamespacestring), [setPrefix](dw.io.XMLStreamWriter.md#setprefixstring-string), [writeAttribute](dw.io.XMLStreamWriter.md#writeattributestring-string), [writeAttribute](dw.io.XMLStreamWriter.md#writeattributestring-string-string), [writeAttribute](dw.io.XMLStreamWriter.md#writeattributestring-string-string-string), [writeCData](dw.io.XMLStreamWriter.md#writecdatastring), [writeCharacters](dw.io.XMLStreamWriter.md#writecharactersstring), [writeComment](dw.io.XMLStreamWriter.md#writecommentstring), [writeDTD](dw.io.XMLStreamWriter.md#writedtdstring), [writeDefaultNamespace](dw.io.XMLStreamWriter.md#writedefaultnamespacestring), [writeEmptyElement](dw.io.XMLStreamWriter.md#writeemptyelementstring), [writeEmptyElement](dw.io.XMLStreamWriter.md#writeemptyelementstring-string), [writeEmptyElement](dw.io.XMLStreamWriter.md#writeemptyelementstring-string-string), [writeEndDocument](dw.io.XMLStreamWriter.md#writeenddocument), [writeEndElement](dw.io.XMLStreamWriter.md#writeendelement), [writeEntityRef](dw.io.XMLStreamWriter.md#writeentityrefstring), [writeNamespace](dw.io.XMLStreamWriter.md#writenamespacestring-string), [writeProcessingInstruction](dw.io.XMLStreamWriter.md#writeprocessinginstructionstring), [writeProcessingInstruction](dw.io.XMLStreamWriter.md#writeprocessinginstructionstring-string), [writeRaw](dw.io.XMLStreamWriter.md#writerawstring), [writeStartDocument](dw.io.XMLStreamWriter.md#writestartdocument), [writeStartDocument](dw.io.XMLStreamWriter.md#writestartdocumentstring), [writeStartDocument](dw.io.XMLStreamWriter.md#writestartdocumentstring-string), [writeStartElement](dw.io.XMLStreamWriter.md#writestartelementstring), [writeStartElement](dw.io.XMLStreamWriter.md#writestartelementstring-string), [writeStartElement](dw.io.XMLStreamWriter.md#writestartelementstring-string-string)
|
|
42
|
-
### Methods inherited from class Object
|
|
43
|
-
|
|
44
|
-
[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)
|
|
45
|
-
## Property Details
|
|
46
|
-
|
|
47
|
-
### indent
|
|
48
|
-
- indent: [String](TopLevel.String.md)
|
|
49
|
-
- : Returns the indent.
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
---
|
|
53
|
-
|
|
54
|
-
### newLine
|
|
55
|
-
- newLine: [String](TopLevel.String.md)
|
|
56
|
-
- : Returns the string that is used for a new line character. The
|
|
57
|
-
default is the normal new line character.
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## Constructor Details
|
|
64
|
-
|
|
65
|
-
### XMLIndentingStreamWriter(Writer)
|
|
66
|
-
- XMLIndentingStreamWriter(writer: [Writer](dw.io.Writer.md))
|
|
67
|
-
- : Constructs the writer for the specified writer.
|
|
68
|
-
|
|
69
|
-
**Parameters:**
|
|
70
|
-
- writer - the writer to use.
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
---
|
|
74
|
-
|
|
75
|
-
## Method Details
|
|
76
|
-
|
|
77
|
-
### getIndent()
|
|
78
|
-
- getIndent(): [String](TopLevel.String.md)
|
|
79
|
-
- : Returns the indent.
|
|
80
|
-
|
|
81
|
-
**Returns:**
|
|
82
|
-
- Returns the indent.
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
---
|
|
86
|
-
|
|
87
|
-
### getNewLine()
|
|
88
|
-
- getNewLine(): [String](TopLevel.String.md)
|
|
89
|
-
- : Returns the string that is used for a new line character. The
|
|
90
|
-
default is the normal new line character.
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
**Returns:**
|
|
94
|
-
- the new line.
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
---
|
|
98
|
-
|
|
99
|
-
### setIndent(String)
|
|
100
|
-
- setIndent(indent: [String](TopLevel.String.md)): void
|
|
101
|
-
- : Specifies a string that will be used as identing characters. The
|
|
102
|
-
default are two space characters.
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
**Parameters:**
|
|
106
|
-
- indent - The indent to set.
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
---
|
|
110
|
-
|
|
111
|
-
### setNewLine(String)
|
|
112
|
-
- setNewLine(newLine: [String](TopLevel.String.md)): void
|
|
113
|
-
- : Sets the string that is used for a new line character.
|
|
114
|
-
|
|
115
|
-
**Parameters:**
|
|
116
|
-
- newLine - The newLine to set.
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
---
|
|
120
|
-
|
|
121
|
-
<!-- prettier-ignore-end -->
|