@chilkat/react-native 11.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (530) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/ChilkatRN.podspec +44 -0
  3. package/LICENSE +254 -0
  4. package/README.md +67 -0
  5. package/android/CMakeLists.txt +60 -0
  6. package/android/build.gradle +148 -0
  7. package/android/gradle.properties +5 -0
  8. package/android/src/main/AndroidManifest.xml +2 -0
  9. package/android/src/main/cpp/cpp-adapter.cpp +12 -0
  10. package/android/src/main/java/com/margelo/nitro/chilkat/ChilkatRNPackage.java +33 -0
  11. package/chilkat-checksums.json +9 -0
  12. package/cpp/HybridAi.cpp +660 -0
  13. package/cpp/HybridAi.hpp +159 -0
  14. package/cpp/HybridAsn.cpp +403 -0
  15. package/cpp/HybridAsn.hpp +105 -0
  16. package/cpp/HybridAuthAws.cpp +188 -0
  17. package/cpp/HybridAuthAws.hpp +55 -0
  18. package/cpp/HybridAuthAzureSAS.cpp +142 -0
  19. package/cpp/HybridAuthAzureSAS.hpp +47 -0
  20. package/cpp/HybridAuthAzureStorage.cpp +144 -0
  21. package/cpp/HybridAuthAzureStorage.hpp +47 -0
  22. package/cpp/HybridAuthGoogle.cpp +215 -0
  23. package/cpp/HybridAuthGoogle.hpp +67 -0
  24. package/cpp/HybridBinData.cpp +439 -0
  25. package/cpp/HybridBinData.hpp +112 -0
  26. package/cpp/HybridBz2.cpp +177 -0
  27. package/cpp/HybridBz2.hpp +58 -0
  28. package/cpp/HybridCache.cpp +314 -0
  29. package/cpp/HybridCache.hpp +82 -0
  30. package/cpp/HybridCert.cpp +840 -0
  31. package/cpp/HybridCert.hpp +196 -0
  32. package/cpp/HybridCertChain.cpp +149 -0
  33. package/cpp/HybridCertChain.hpp +50 -0
  34. package/cpp/HybridCertStore.cpp +276 -0
  35. package/cpp/HybridCertStore.hpp +78 -0
  36. package/cpp/HybridCharset.cpp +333 -0
  37. package/cpp/HybridCharset.hpp +83 -0
  38. package/cpp/HybridCkDateTime.cpp +384 -0
  39. package/cpp/HybridCkDateTime.hpp +105 -0
  40. package/cpp/HybridCodeSign.cpp +156 -0
  41. package/cpp/HybridCodeSign.hpp +55 -0
  42. package/cpp/HybridCompression.cpp +422 -0
  43. package/cpp/HybridCompression.hpp +100 -0
  44. package/cpp/HybridCrypt2.cpp +1517 -0
  45. package/cpp/HybridCrypt2.hpp +320 -0
  46. package/cpp/HybridCsr.cpp +292 -0
  47. package/cpp/HybridCsr.hpp +77 -0
  48. package/cpp/HybridCsv.cpp +382 -0
  49. package/cpp/HybridCsv.hpp +101 -0
  50. package/cpp/HybridDh.cpp +137 -0
  51. package/cpp/HybridDh.hpp +47 -0
  52. package/cpp/HybridDirTree.cpp +167 -0
  53. package/cpp/HybridDirTree.hpp +53 -0
  54. package/cpp/HybridDkim.cpp +249 -0
  55. package/cpp/HybridDkim.hpp +74 -0
  56. package/cpp/HybridDns.cpp +193 -0
  57. package/cpp/HybridDns.hpp +64 -0
  58. package/cpp/HybridDsa.cpp +453 -0
  59. package/cpp/HybridDsa.hpp +112 -0
  60. package/cpp/HybridDtObj.cpp +172 -0
  61. package/cpp/HybridDtObj.hpp +57 -0
  62. package/cpp/HybridEcc.cpp +195 -0
  63. package/cpp/HybridEcc.hpp +55 -0
  64. package/cpp/HybridEdDSA.cpp +147 -0
  65. package/cpp/HybridEdDSA.hpp +47 -0
  66. package/cpp/HybridEmail.cpp +1911 -0
  67. package/cpp/HybridEmail.hpp +419 -0
  68. package/cpp/HybridEmailBundle.cpp +204 -0
  69. package/cpp/HybridEmailBundle.hpp +64 -0
  70. package/cpp/HybridFileAccess.cpp +631 -0
  71. package/cpp/HybridFileAccess.hpp +149 -0
  72. package/cpp/HybridFtp2.cpp +2308 -0
  73. package/cpp/HybridFtp2.hpp +462 -0
  74. package/cpp/HybridGlobal.cpp +221 -0
  75. package/cpp/HybridGlobal.hpp +68 -0
  76. package/cpp/HybridGzip.cpp +440 -0
  77. package/cpp/HybridGzip.hpp +105 -0
  78. package/cpp/HybridHashtable.cpp +211 -0
  79. package/cpp/HybridHashtable.hpp +64 -0
  80. package/cpp/HybridHtmlToText.cpp +136 -0
  81. package/cpp/HybridHtmlToText.hpp +47 -0
  82. package/cpp/HybridHtmlToXml.cpp +218 -0
  83. package/cpp/HybridHtmlToXml.hpp +65 -0
  84. package/cpp/HybridHttp.cpp +2067 -0
  85. package/cpp/HybridHttp.hpp +416 -0
  86. package/cpp/HybridHttpCurl.cpp +337 -0
  87. package/cpp/HybridHttpCurl.hpp +93 -0
  88. package/cpp/HybridHttpRequest.cpp +455 -0
  89. package/cpp/HybridHttpRequest.hpp +109 -0
  90. package/cpp/HybridHttpResponse.cpp +340 -0
  91. package/cpp/HybridHttpResponse.hpp +86 -0
  92. package/cpp/HybridImap.cpp +1818 -0
  93. package/cpp/HybridImap.hpp +363 -0
  94. package/cpp/HybridJavaKeyStore.cpp +387 -0
  95. package/cpp/HybridJavaKeyStore.hpp +98 -0
  96. package/cpp/HybridJs.cpp +154 -0
  97. package/cpp/HybridJs.hpp +54 -0
  98. package/cpp/HybridJsonArray.cpp +441 -0
  99. package/cpp/HybridJsonArray.hpp +120 -0
  100. package/cpp/HybridJsonObject.cpp +1125 -0
  101. package/cpp/HybridJsonObject.hpp +260 -0
  102. package/cpp/HybridJwe.cpp +294 -0
  103. package/cpp/HybridJwe.hpp +82 -0
  104. package/cpp/HybridJws.cpp +290 -0
  105. package/cpp/HybridJws.hpp +82 -0
  106. package/cpp/HybridJwt.cpp +198 -0
  107. package/cpp/HybridJwt.hpp +57 -0
  108. package/cpp/HybridLog.cpp +212 -0
  109. package/cpp/HybridLog.hpp +63 -0
  110. package/cpp/HybridMailMan.cpp +1853 -0
  111. package/cpp/HybridMailMan.hpp +386 -0
  112. package/cpp/HybridMailboxes.cpp +165 -0
  113. package/cpp/HybridMailboxes.hpp +54 -0
  114. package/cpp/HybridMcp.cpp +322 -0
  115. package/cpp/HybridMcp.hpp +85 -0
  116. package/cpp/HybridMessageSet.cpp +162 -0
  117. package/cpp/HybridMessageSet.hpp +54 -0
  118. package/cpp/HybridMht.cpp +700 -0
  119. package/cpp/HybridMht.hpp +165 -0
  120. package/cpp/HybridMime.cpp +1119 -0
  121. package/cpp/HybridMime.hpp +266 -0
  122. package/cpp/HybridNtlm.cpp +333 -0
  123. package/cpp/HybridNtlm.hpp +83 -0
  124. package/cpp/HybridOAuth1.cpp +307 -0
  125. package/cpp/HybridOAuth1.hpp +78 -0
  126. package/cpp/HybridOAuth2.cpp +515 -0
  127. package/cpp/HybridOAuth2.hpp +127 -0
  128. package/cpp/HybridPdf.cpp +370 -0
  129. package/cpp/HybridPdf.hpp +103 -0
  130. package/cpp/HybridPem.cpp +327 -0
  131. package/cpp/HybridPem.hpp +88 -0
  132. package/cpp/HybridPfx.cpp +343 -0
  133. package/cpp/HybridPfx.hpp +87 -0
  134. package/cpp/HybridPkcs11.cpp +318 -0
  135. package/cpp/HybridPkcs11.hpp +88 -0
  136. package/cpp/HybridPrivateKey.cpp +464 -0
  137. package/cpp/HybridPrivateKey.hpp +117 -0
  138. package/cpp/HybridPrng.cpp +192 -0
  139. package/cpp/HybridPrng.hpp +57 -0
  140. package/cpp/HybridPublicKey.cpp +238 -0
  141. package/cpp/HybridPublicKey.hpp +68 -0
  142. package/cpp/HybridRest.cpp +993 -0
  143. package/cpp/HybridRest.hpp +214 -0
  144. package/cpp/HybridRsa.cpp +348 -0
  145. package/cpp/HybridRsa.hpp +90 -0
  146. package/cpp/HybridSCard.cpp +328 -0
  147. package/cpp/HybridSCard.hpp +91 -0
  148. package/cpp/HybridSFtp.cpp +1889 -0
  149. package/cpp/HybridSFtp.hpp +366 -0
  150. package/cpp/HybridSFtpDir.cpp +119 -0
  151. package/cpp/HybridSFtpDir.hpp +43 -0
  152. package/cpp/HybridSFtpFile.cpp +203 -0
  153. package/cpp/HybridSFtpFile.hpp +60 -0
  154. package/cpp/HybridScMinidriver.cpp +341 -0
  155. package/cpp/HybridScMinidriver.hpp +88 -0
  156. package/cpp/HybridScp.cpp +398 -0
  157. package/cpp/HybridScp.hpp +96 -0
  158. package/cpp/HybridSecrets.cpp +328 -0
  159. package/cpp/HybridSecrets.hpp +84 -0
  160. package/cpp/HybridSecureString.cpp +175 -0
  161. package/cpp/HybridSecureString.hpp +55 -0
  162. package/cpp/HybridServerSentEvent.cpp +112 -0
  163. package/cpp/HybridServerSentEvent.hpp +41 -0
  164. package/cpp/HybridSocket.cpp +1567 -0
  165. package/cpp/HybridSocket.hpp +336 -0
  166. package/cpp/HybridSpider.cpp +543 -0
  167. package/cpp/HybridSpider.hpp +138 -0
  168. package/cpp/HybridSsh.cpp +1330 -0
  169. package/cpp/HybridSsh.hpp +282 -0
  170. package/cpp/HybridSshKey.cpp +310 -0
  171. package/cpp/HybridSshKey.hpp +83 -0
  172. package/cpp/HybridSshTunnel.cpp +687 -0
  173. package/cpp/HybridSshTunnel.hpp +159 -0
  174. package/cpp/HybridStream.cpp +496 -0
  175. package/cpp/HybridStream.hpp +123 -0
  176. package/cpp/HybridStringArray.cpp +368 -0
  177. package/cpp/HybridStringArray.hpp +99 -0
  178. package/cpp/HybridStringBuilder.cpp +739 -0
  179. package/cpp/HybridStringBuilder.hpp +178 -0
  180. package/cpp/HybridStringTable.cpp +218 -0
  181. package/cpp/HybridStringTable.hpp +66 -0
  182. package/cpp/HybridTar.cpp +547 -0
  183. package/cpp/HybridTar.hpp +134 -0
  184. package/cpp/HybridTrustedRoots.cpp +178 -0
  185. package/cpp/HybridTrustedRoots.hpp +61 -0
  186. package/cpp/HybridUnixCompress.cpp +191 -0
  187. package/cpp/HybridUnixCompress.hpp +60 -0
  188. package/cpp/HybridUpload.cpp +427 -0
  189. package/cpp/HybridUpload.hpp +114 -0
  190. package/cpp/HybridUrl.cpp +152 -0
  191. package/cpp/HybridUrl.hpp +48 -0
  192. package/cpp/HybridWebSocket.cpp +378 -0
  193. package/cpp/HybridWebSocket.hpp +103 -0
  194. package/cpp/HybridXml.cpp +1527 -0
  195. package/cpp/HybridXml.hpp +340 -0
  196. package/cpp/HybridXmlCertVault.cpp +215 -0
  197. package/cpp/HybridXmlCertVault.hpp +63 -0
  198. package/cpp/HybridXmlDSig.cpp +328 -0
  199. package/cpp/HybridXmlDSig.hpp +88 -0
  200. package/cpp/HybridXmlDSigGen.cpp +549 -0
  201. package/cpp/HybridXmlDSigGen.hpp +126 -0
  202. package/cpp/HybridXmp.cpp +329 -0
  203. package/cpp/HybridXmp.hpp +86 -0
  204. package/cpp/HybridZip.cpp +1000 -0
  205. package/cpp/HybridZip.hpp +226 -0
  206. package/cpp/HybridZipCrc.cpp +162 -0
  207. package/cpp/HybridZipCrc.hpp +57 -0
  208. package/cpp/HybridZipEntry.cpp +395 -0
  209. package/cpp/HybridZipEntry.hpp +102 -0
  210. package/cpp/runtime/AsyncCall.hpp +96 -0
  211. package/cpp/runtime/Bytes.hpp +49 -0
  212. package/cpp/runtime/ChilkatError.hpp +66 -0
  213. package/cpp/runtime/ChilkatObject.hpp +219 -0
  214. package/cpp/runtime/ProgLang.hpp +9 -0
  215. package/cpp/runtime/ProgressAdapter.hpp +43 -0
  216. package/nitro.json +113 -0
  217. package/nitrogen/generated/.gitattributes +1 -0
  218. package/nitrogen/generated/android/ChilkatRN+autolinking.cmake +179 -0
  219. package/nitrogen/generated/android/ChilkatRN+autolinking.gradle +27 -0
  220. package/nitrogen/generated/android/ChilkatRNOnLoad.cpp +1029 -0
  221. package/nitrogen/generated/android/ChilkatRNOnLoad.hpp +34 -0
  222. package/nitrogen/generated/android/kotlin/com/margelo/nitro/chilkat/ChilkatRNOnLoad.kt +35 -0
  223. package/nitrogen/generated/ios/ChilkatRN+autolinking.rb +62 -0
  224. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Bridge.cpp +17 -0
  225. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Bridge.hpp +27 -0
  226. package/nitrogen/generated/ios/ChilkatRN-Swift-Cxx-Umbrella.hpp +38 -0
  227. package/nitrogen/generated/ios/ChilkatRNAutolinking.mm +1015 -0
  228. package/nitrogen/generated/ios/ChilkatRNAutolinking.swift +16 -0
  229. package/nitrogen/generated/shared/c++/HybridAiSpec.cpp +114 -0
  230. package/nitrogen/generated/shared/c++/HybridAiSpec.hpp +175 -0
  231. package/nitrogen/generated/shared/c++/HybridAsnSpec.cpp +70 -0
  232. package/nitrogen/generated/shared/c++/HybridAsnSpec.hpp +116 -0
  233. package/nitrogen/generated/shared/c++/HybridAuthAwsSpec.cpp +49 -0
  234. package/nitrogen/generated/shared/c++/HybridAuthAwsSpec.hpp +89 -0
  235. package/nitrogen/generated/shared/c++/HybridAuthAzureSASSpec.cpp +38 -0
  236. package/nitrogen/generated/shared/c++/HybridAuthAzureSASSpec.hpp +78 -0
  237. package/nitrogen/generated/shared/c++/HybridAuthAzureStorageSpec.cpp +41 -0
  238. package/nitrogen/generated/shared/c++/HybridAuthAzureStorageSpec.hpp +81 -0
  239. package/nitrogen/generated/shared/c++/HybridAuthGoogleSpec.cpp +56 -0
  240. package/nitrogen/generated/shared/c++/HybridAuthGoogleSpec.hpp +108 -0
  241. package/nitrogen/generated/shared/c++/HybridBinDataSpec.cpp +69 -0
  242. package/nitrogen/generated/shared/c++/HybridBinDataSpec.hpp +116 -0
  243. package/nitrogen/generated/shared/c++/HybridBz2Spec.cpp +47 -0
  244. package/nitrogen/generated/shared/c++/HybridBz2Spec.hpp +93 -0
  245. package/nitrogen/generated/shared/c++/HybridCacheSpec.cpp +57 -0
  246. package/nitrogen/generated/shared/c++/HybridCacheSpec.hpp +106 -0
  247. package/nitrogen/generated/shared/c++/HybridCertChainSpec.cpp +40 -0
  248. package/nitrogen/generated/shared/c++/HybridCertChainSpec.hpp +89 -0
  249. package/nitrogen/generated/shared/c++/HybridCertSpec.cpp +138 -0
  250. package/nitrogen/generated/shared/c++/HybridCertSpec.hpp +205 -0
  251. package/nitrogen/generated/shared/c++/HybridCertStoreSpec.cpp +55 -0
  252. package/nitrogen/generated/shared/c++/HybridCertStoreSpec.hpp +104 -0
  253. package/nitrogen/generated/shared/c++/HybridCharsetSpec.cpp +61 -0
  254. package/nitrogen/generated/shared/c++/HybridCharsetSpec.hpp +101 -0
  255. package/nitrogen/generated/shared/c++/HybridCkDateTimeSpec.cpp +66 -0
  256. package/nitrogen/generated/shared/c++/HybridCkDateTimeSpec.hpp +115 -0
  257. package/nitrogen/generated/shared/c++/HybridCodeSignSpec.cpp +44 -0
  258. package/nitrogen/generated/shared/c++/HybridCodeSignSpec.hpp +93 -0
  259. package/nitrogen/generated/shared/c++/HybridCompressionSpec.cpp +79 -0
  260. package/nitrogen/generated/shared/c++/HybridCompressionSpec.hpp +134 -0
  261. package/nitrogen/generated/shared/c++/HybridCrypt2Spec.cpp +215 -0
  262. package/nitrogen/generated/shared/c++/HybridCrypt2Spec.hpp +283 -0
  263. package/nitrogen/generated/shared/c++/HybridCsrSpec.cpp +61 -0
  264. package/nitrogen/generated/shared/c++/HybridCsrSpec.hpp +116 -0
  265. package/nitrogen/generated/shared/c++/HybridCsvSpec.cpp +72 -0
  266. package/nitrogen/generated/shared/c++/HybridCsvSpec.hpp +121 -0
  267. package/nitrogen/generated/shared/c++/HybridDhSpec.cpp +37 -0
  268. package/nitrogen/generated/shared/c++/HybridDhSpec.hpp +77 -0
  269. package/nitrogen/generated/shared/c++/HybridDirTreeSpec.cpp +46 -0
  270. package/nitrogen/generated/shared/c++/HybridDirTreeSpec.hpp +86 -0
  271. package/nitrogen/generated/shared/c++/HybridDkimSpec.cpp +60 -0
  272. package/nitrogen/generated/shared/c++/HybridDkimSpec.hpp +109 -0
  273. package/nitrogen/generated/shared/c++/HybridDnsSpec.cpp +51 -0
  274. package/nitrogen/generated/shared/c++/HybridDnsSpec.hpp +97 -0
  275. package/nitrogen/generated/shared/c++/HybridDsaSpec.cpp +73 -0
  276. package/nitrogen/generated/shared/c++/HybridDsaSpec.hpp +116 -0
  277. package/nitrogen/generated/shared/c++/HybridDtObjSpec.cpp +50 -0
  278. package/nitrogen/generated/shared/c++/HybridDtObjSpec.hpp +90 -0
  279. package/nitrogen/generated/shared/c++/HybridEccSpec.cpp +41 -0
  280. package/nitrogen/generated/shared/c++/HybridEccSpec.hpp +96 -0
  281. package/nitrogen/generated/shared/c++/HybridEdDSASpec.cpp +38 -0
  282. package/nitrogen/generated/shared/c++/HybridEdDSASpec.hpp +90 -0
  283. package/nitrogen/generated/shared/c++/HybridEmailBundleSpec.cpp +45 -0
  284. package/nitrogen/generated/shared/c++/HybridEmailBundleSpec.hpp +91 -0
  285. package/nitrogen/generated/shared/c++/HybridEmailSpec.cpp +259 -0
  286. package/nitrogen/generated/shared/c++/HybridEmailSpec.hpp +326 -0
  287. package/nitrogen/generated/shared/c++/HybridFileAccessSpec.cpp +90 -0
  288. package/nitrogen/generated/shared/c++/HybridFileAccessSpec.hpp +140 -0
  289. package/nitrogen/generated/shared/c++/HybridFtp2Spec.cpp +367 -0
  290. package/nitrogen/generated/shared/c++/HybridFtp2Spec.hpp +434 -0
  291. package/nitrogen/generated/shared/c++/HybridGlobalSpec.cpp +59 -0
  292. package/nitrogen/generated/shared/c++/HybridGlobalSpec.hpp +99 -0
  293. package/nitrogen/generated/shared/c++/HybridGzipSpec.cpp +79 -0
  294. package/nitrogen/generated/shared/c++/HybridGzipSpec.hpp +134 -0
  295. package/nitrogen/generated/shared/c++/HybridHashtableSpec.cpp +45 -0
  296. package/nitrogen/generated/shared/c++/HybridHashtableSpec.hpp +91 -0
  297. package/nitrogen/generated/shared/c++/HybridHtmlToTextSpec.cpp +40 -0
  298. package/nitrogen/generated/shared/c++/HybridHtmlToTextSpec.hpp +83 -0
  299. package/nitrogen/generated/shared/c++/HybridHtmlToXmlSpec.cpp +49 -0
  300. package/nitrogen/generated/shared/c++/HybridHtmlToXmlSpec.hpp +95 -0
  301. package/nitrogen/generated/shared/c++/HybridHttpCurlSpec.cpp +67 -0
  302. package/nitrogen/generated/shared/c++/HybridHttpCurlSpec.hpp +125 -0
  303. package/nitrogen/generated/shared/c++/HybridHttpRequestSpec.cpp +76 -0
  304. package/nitrogen/generated/shared/c++/HybridHttpRequestSpec.hpp +122 -0
  305. package/nitrogen/generated/shared/c++/HybridHttpResponseSpec.cpp +64 -0
  306. package/nitrogen/generated/shared/c++/HybridHttpResponseSpec.hpp +119 -0
  307. package/nitrogen/generated/shared/c++/HybridHttpSpec.cpp +334 -0
  308. package/nitrogen/generated/shared/c++/HybridHttpSpec.hpp +407 -0
  309. package/nitrogen/generated/shared/c++/HybridImapSpec.cpp +275 -0
  310. package/nitrogen/generated/shared/c++/HybridImapSpec.hpp +360 -0
  311. package/nitrogen/generated/shared/c++/HybridJavaKeyStoreSpec.cpp +65 -0
  312. package/nitrogen/generated/shared/c++/HybridJavaKeyStoreSpec.hpp +132 -0
  313. package/nitrogen/generated/shared/c++/HybridJsSpec.cpp +43 -0
  314. package/nitrogen/generated/shared/c++/HybridJsSpec.hpp +92 -0
  315. package/nitrogen/generated/shared/c++/HybridJsonArraySpec.cpp +76 -0
  316. package/nitrogen/generated/shared/c++/HybridJsonArraySpec.hpp +131 -0
  317. package/nitrogen/generated/shared/c++/HybridJsonObjectSpec.cpp +154 -0
  318. package/nitrogen/generated/shared/c++/HybridJsonObjectSpec.hpp +218 -0
  319. package/nitrogen/generated/shared/c++/HybridJweSpec.cpp +57 -0
  320. package/nitrogen/generated/shared/c++/HybridJweSpec.hpp +112 -0
  321. package/nitrogen/generated/shared/c++/HybridJwsSpec.cpp +57 -0
  322. package/nitrogen/generated/shared/c++/HybridJwsSpec.hpp +115 -0
  323. package/nitrogen/generated/shared/c++/HybridJwtSpec.cpp +43 -0
  324. package/nitrogen/generated/shared/c++/HybridJwtSpec.hpp +92 -0
  325. package/nitrogen/generated/shared/c++/HybridLogSpec.cpp +44 -0
  326. package/nitrogen/generated/shared/c++/HybridLogSpec.hpp +85 -0
  327. package/nitrogen/generated/shared/c++/HybridMailManSpec.cpp +311 -0
  328. package/nitrogen/generated/shared/c++/HybridMailManSpec.hpp +396 -0
  329. package/nitrogen/generated/shared/c++/HybridMailboxesSpec.cpp +40 -0
  330. package/nitrogen/generated/shared/c++/HybridMailboxesSpec.hpp +80 -0
  331. package/nitrogen/generated/shared/c++/HybridMcpSpec.cpp +68 -0
  332. package/nitrogen/generated/shared/c++/HybridMcpSpec.hpp +117 -0
  333. package/nitrogen/generated/shared/c++/HybridMessageSetSpec.cpp +41 -0
  334. package/nitrogen/generated/shared/c++/HybridMessageSetSpec.hpp +84 -0
  335. package/nitrogen/generated/shared/c++/HybridMhtSpec.cpp +138 -0
  336. package/nitrogen/generated/shared/c++/HybridMhtSpec.hpp +181 -0
  337. package/nitrogen/generated/shared/c++/HybridMimeSpec.cpp +169 -0
  338. package/nitrogen/generated/shared/c++/HybridMimeSpec.hpp +233 -0
  339. package/nitrogen/generated/shared/c++/HybridNtlmSpec.cpp +69 -0
  340. package/nitrogen/generated/shared/c++/HybridNtlmSpec.hpp +109 -0
  341. package/nitrogen/generated/shared/c++/HybridOAuth1Spec.cpp +67 -0
  342. package/nitrogen/generated/shared/c++/HybridOAuth1Spec.hpp +110 -0
  343. package/nitrogen/generated/shared/c++/HybridOAuth2Spec.cpp +107 -0
  344. package/nitrogen/generated/shared/c++/HybridOAuth2Spec.hpp +156 -0
  345. package/nitrogen/generated/shared/c++/HybridPdfSpec.cpp +73 -0
  346. package/nitrogen/generated/shared/c++/HybridPdfSpec.hpp +134 -0
  347. package/nitrogen/generated/shared/c++/HybridPemSpec.cpp +63 -0
  348. package/nitrogen/generated/shared/c++/HybridPemSpec.hpp +124 -0
  349. package/nitrogen/generated/shared/c++/HybridPfxSpec.cpp +61 -0
  350. package/nitrogen/generated/shared/c++/HybridPfxSpec.hpp +122 -0
  351. package/nitrogen/generated/shared/c++/HybridPkcs11Spec.cpp +60 -0
  352. package/nitrogen/generated/shared/c++/HybridPkcs11Spec.hpp +115 -0
  353. package/nitrogen/generated/shared/c++/HybridPrivateKeySpec.cpp +76 -0
  354. package/nitrogen/generated/shared/c++/HybridPrivateKeySpec.hpp +131 -0
  355. package/nitrogen/generated/shared/c++/HybridPrngSpec.cpp +42 -0
  356. package/nitrogen/generated/shared/c++/HybridPrngSpec.hpp +85 -0
  357. package/nitrogen/generated/shared/c++/HybridPublicKeySpec.cpp +48 -0
  358. package/nitrogen/generated/shared/c++/HybridPublicKeySpec.hpp +91 -0
  359. package/nitrogen/generated/shared/c++/HybridRestSpec.cpp +150 -0
  360. package/nitrogen/generated/shared/c++/HybridRestSpec.hpp +229 -0
  361. package/nitrogen/generated/shared/c++/HybridRsaSpec.cpp +68 -0
  362. package/nitrogen/generated/shared/c++/HybridRsaSpec.hpp +120 -0
  363. package/nitrogen/generated/shared/c++/HybridSCardSpec.cpp +64 -0
  364. package/nitrogen/generated/shared/c++/HybridSCardSpec.hpp +116 -0
  365. package/nitrogen/generated/shared/c++/HybridSFtpDirSpec.cpp +35 -0
  366. package/nitrogen/generated/shared/c++/HybridSFtpDirSpec.hpp +78 -0
  367. package/nitrogen/generated/shared/c++/HybridSFtpFileSpec.cpp +57 -0
  368. package/nitrogen/generated/shared/c++/HybridSFtpFileSpec.hpp +98 -0
  369. package/nitrogen/generated/shared/c++/HybridSFtpSpec.cpp +284 -0
  370. package/nitrogen/generated/shared/c++/HybridSFtpSpec.hpp +354 -0
  371. package/nitrogen/generated/shared/c++/HybridScMinidriverSpec.cpp +61 -0
  372. package/nitrogen/generated/shared/c++/HybridScMinidriverSpec.hpp +119 -0
  373. package/nitrogen/generated/shared/c++/HybridScpSpec.cpp +78 -0
  374. package/nitrogen/generated/shared/c++/HybridScpSpec.hpp +127 -0
  375. package/nitrogen/generated/shared/c++/HybridSecretsSpec.cpp +65 -0
  376. package/nitrogen/generated/shared/c++/HybridSecretsSpec.hpp +120 -0
  377. package/nitrogen/generated/shared/c++/HybridSecureStringSpec.cpp +42 -0
  378. package/nitrogen/generated/shared/c++/HybridSecureStringSpec.hpp +88 -0
  379. package/nitrogen/generated/shared/c++/HybridServerSentEventSpec.cpp +35 -0
  380. package/nitrogen/generated/shared/c++/HybridServerSentEventSpec.hpp +75 -0
  381. package/nitrogen/generated/shared/c++/HybridSocketSpec.cpp +262 -0
  382. package/nitrogen/generated/shared/c++/HybridSocketSpec.hpp +327 -0
  383. package/nitrogen/generated/shared/c++/HybridSpiderSpec.cpp +110 -0
  384. package/nitrogen/generated/shared/c++/HybridSpiderSpec.hpp +153 -0
  385. package/nitrogen/generated/shared/c++/HybridSshKeySpec.cpp +59 -0
  386. package/nitrogen/generated/shared/c++/HybridSshKeySpec.hpp +102 -0
  387. package/nitrogen/generated/shared/c++/HybridSshSpec.cpp +215 -0
  388. package/nitrogen/generated/shared/c++/HybridSshSpec.hpp +276 -0
  389. package/nitrogen/generated/shared/c++/HybridSshTunnelSpec.cpp +136 -0
  390. package/nitrogen/generated/shared/c++/HybridSshTunnelSpec.hpp +191 -0
  391. package/nitrogen/generated/shared/c++/HybridStreamSpec.cpp +100 -0
  392. package/nitrogen/generated/shared/c++/HybridStreamSpec.hpp +150 -0
  393. package/nitrogen/generated/shared/c++/HybridStringArraySpec.cpp +66 -0
  394. package/nitrogen/generated/shared/c++/HybridStringArraySpec.hpp +109 -0
  395. package/nitrogen/generated/shared/c++/HybridStringBuilderSpec.cpp +104 -0
  396. package/nitrogen/generated/shared/c++/HybridStringBuilderSpec.hpp +156 -0
  397. package/nitrogen/generated/shared/c++/HybridStringTableSpec.cpp +46 -0
  398. package/nitrogen/generated/shared/c++/HybridStringTableSpec.hpp +89 -0
  399. package/nitrogen/generated/shared/c++/HybridTarSpec.cpp +110 -0
  400. package/nitrogen/generated/shared/c++/HybridTarSpec.hpp +156 -0
  401. package/nitrogen/generated/shared/c++/HybridTrustedRootsSpec.cpp +48 -0
  402. package/nitrogen/generated/shared/c++/HybridTrustedRootsSpec.hpp +97 -0
  403. package/nitrogen/generated/shared/c++/HybridUnixCompressSpec.cpp +48 -0
  404. package/nitrogen/generated/shared/c++/HybridUnixCompressSpec.hpp +91 -0
  405. package/nitrogen/generated/shared/c++/HybridUploadSpec.cpp +98 -0
  406. package/nitrogen/generated/shared/c++/HybridUploadSpec.hpp +141 -0
  407. package/nitrogen/generated/shared/c++/HybridUrlSpec.cpp +42 -0
  408. package/nitrogen/generated/shared/c++/HybridUrlSpec.hpp +82 -0
  409. package/nitrogen/generated/shared/c++/HybridWebSocketSpec.cpp +80 -0
  410. package/nitrogen/generated/shared/c++/HybridWebSocketSpec.hpp +135 -0
  411. package/nitrogen/generated/shared/c++/HybridXmlCertVaultSpec.cpp +45 -0
  412. package/nitrogen/generated/shared/c++/HybridXmlCertVaultSpec.hpp +94 -0
  413. package/nitrogen/generated/shared/c++/HybridXmlDSigGenSpec.cpp +99 -0
  414. package/nitrogen/generated/shared/c++/HybridXmlDSigGenSpec.hpp +163 -0
  415. package/nitrogen/generated/shared/c++/HybridXmlDSigSpec.cpp +62 -0
  416. package/nitrogen/generated/shared/c++/HybridXmlDSigSpec.hpp +126 -0
  417. package/nitrogen/generated/shared/c++/HybridXmlSpec.cpp +203 -0
  418. package/nitrogen/generated/shared/c++/HybridXmlSpec.hpp +253 -0
  419. package/nitrogen/generated/shared/c++/HybridXmpSpec.cpp +58 -0
  420. package/nitrogen/generated/shared/c++/HybridXmpSpec.hpp +104 -0
  421. package/nitrogen/generated/shared/c++/HybridZipCrcSpec.cpp +43 -0
  422. package/nitrogen/generated/shared/c++/HybridZipCrcSpec.hpp +92 -0
  423. package/nitrogen/generated/shared/c++/HybridZipEntrySpec.cpp +82 -0
  424. package/nitrogen/generated/shared/c++/HybridZipEntrySpec.hpp +137 -0
  425. package/nitrogen/generated/shared/c++/HybridZipSpec.cpp +176 -0
  426. package/nitrogen/generated/shared/c++/HybridZipSpec.hpp +231 -0
  427. package/package.json +46 -0
  428. package/react-native.config.js +9 -0
  429. package/scripts/fetch-chilkat.js +184 -0
  430. package/src/index.ts +306 -0
  431. package/src/runtime/chilkat.ts +25 -0
  432. package/src/specs/Ai.nitro.ts +1288 -0
  433. package/src/specs/Asn.nitro.ts +509 -0
  434. package/src/specs/AuthAws.nitro.ts +234 -0
  435. package/src/specs/AuthAzureSAS.nitro.ts +205 -0
  436. package/src/specs/AuthAzureStorage.nitro.ts +172 -0
  437. package/src/specs/AuthGoogle.nitro.ts +291 -0
  438. package/src/specs/BinData.nitro.ts +470 -0
  439. package/src/specs/Bz2.nitro.ts +269 -0
  440. package/src/specs/Cache.nitro.ts +483 -0
  441. package/src/specs/Cert.nitro.ts +1279 -0
  442. package/src/specs/CertChain.nitro.ts +312 -0
  443. package/src/specs/CertStore.nitro.ts +430 -0
  444. package/src/specs/Charset.nitro.ts +518 -0
  445. package/src/specs/CkDateTime.nitro.ts +492 -0
  446. package/src/specs/CodeSign.nitro.ts +307 -0
  447. package/src/specs/Compression.nitro.ts +654 -0
  448. package/src/specs/Crypt2.nitro.ts +2387 -0
  449. package/src/specs/Csr.nitro.ts +461 -0
  450. package/src/specs/Csv.nitro.ts +670 -0
  451. package/src/specs/Dh.nitro.ts +343 -0
  452. package/src/specs/DirTree.nitro.ts +332 -0
  453. package/src/specs/Dkim.nitro.ts +595 -0
  454. package/src/specs/Dns.nitro.ts +271 -0
  455. package/src/specs/Dsa.nitro.ts +653 -0
  456. package/src/specs/DtObj.nitro.ts +198 -0
  457. package/src/specs/Ecc.nitro.ts +375 -0
  458. package/src/specs/EdDSA.nitro.ts +273 -0
  459. package/src/specs/Email.nitro.ts +2921 -0
  460. package/src/specs/EmailBundle.nitro.ts +334 -0
  461. package/src/specs/FileAccess.nitro.ts +836 -0
  462. package/src/specs/Ftp2.nitro.ts +3943 -0
  463. package/src/specs/Global.nitro.ts +319 -0
  464. package/src/specs/Gzip.nitro.ts +646 -0
  465. package/src/specs/Hashtable.nitro.ts +356 -0
  466. package/src/specs/HtmlToText.nitro.ts +238 -0
  467. package/src/specs/HtmlToXml.nitro.ts +323 -0
  468. package/src/specs/Http.nitro.ts +3095 -0
  469. package/src/specs/HttpCurl.nitro.ts +550 -0
  470. package/src/specs/HttpRequest.nitro.ts +522 -0
  471. package/src/specs/HttpResponse.nitro.ts +424 -0
  472. package/src/specs/Imap.nitro.ts +2991 -0
  473. package/src/specs/JavaKeyStore.nitro.ts +619 -0
  474. package/src/specs/Js.nitro.ts +263 -0
  475. package/src/specs/JsonArray.nitro.ts +681 -0
  476. package/src/specs/JsonObject.nitro.ts +1454 -0
  477. package/src/specs/Jwe.nitro.ts +756 -0
  478. package/src/specs/Jws.nitro.ts +733 -0
  479. package/src/specs/Jwt.nitro.ts +380 -0
  480. package/src/specs/Log.nitro.ts +258 -0
  481. package/src/specs/MailMan.nitro.ts +3571 -0
  482. package/src/specs/Mailboxes.nitro.ts +251 -0
  483. package/src/specs/Mcp.nitro.ts +491 -0
  484. package/src/specs/MessageSet.nitro.ts +320 -0
  485. package/src/specs/Mht.nitro.ts +1684 -0
  486. package/src/specs/Mime.nitro.ts +1745 -0
  487. package/src/specs/Ntlm.nitro.ts +556 -0
  488. package/src/specs/OAuth1.nitro.ts +331 -0
  489. package/src/specs/OAuth2.nitro.ts +1023 -0
  490. package/src/specs/Pdf.nitro.ts +740 -0
  491. package/src/specs/Pem.nitro.ts +484 -0
  492. package/src/specs/Pfx.nitro.ts +1003 -0
  493. package/src/specs/Pkcs11.nitro.ts +559 -0
  494. package/src/specs/PrivateKey.nitro.ts +994 -0
  495. package/src/specs/Prng.nitro.ts +348 -0
  496. package/src/specs/PublicKey.nitro.ts +610 -0
  497. package/src/specs/Rest.nitro.ts +1972 -0
  498. package/src/specs/Rsa.nitro.ts +453 -0
  499. package/src/specs/SCard.nitro.ts +739 -0
  500. package/src/specs/SFtp.nitro.ts +3138 -0
  501. package/src/specs/SFtpDir.nitro.ts +213 -0
  502. package/src/specs/SFtpFile.nitro.ts +452 -0
  503. package/src/specs/ScMinidriver.nitro.ts +443 -0
  504. package/src/specs/Scp.nitro.ts +708 -0
  505. package/src/specs/Secrets.nitro.ts +470 -0
  506. package/src/specs/SecureString.nitro.ts +231 -0
  507. package/src/specs/ServerSentEvent.nitro.ts +183 -0
  508. package/src/specs/Socket.nitro.ts +3335 -0
  509. package/src/specs/Spider.nitro.ts +609 -0
  510. package/src/specs/Ssh.nitro.ts +2842 -0
  511. package/src/specs/SshKey.nitro.ts +740 -0
  512. package/src/specs/SshTunnel.nitro.ts +1243 -0
  513. package/src/specs/Stream.nitro.ts +737 -0
  514. package/src/specs/StringArray.nitro.ts +396 -0
  515. package/src/specs/StringBuilder.nitro.ts +920 -0
  516. package/src/specs/StringTable.nitro.ts +271 -0
  517. package/src/specs/Tar.nitro.ts +804 -0
  518. package/src/specs/TrustedRoots.nitro.ts +360 -0
  519. package/src/specs/UnixCompress.nitro.ts +293 -0
  520. package/src/specs/Upload.nitro.ts +623 -0
  521. package/src/specs/Url.nitro.ts +246 -0
  522. package/src/specs/WebSocket.nitro.ts +840 -0
  523. package/src/specs/Xml.nitro.ts +1988 -0
  524. package/src/specs/XmlCertVault.nitro.ts +259 -0
  525. package/src/specs/XmlDSig.nitro.ts +464 -0
  526. package/src/specs/XmlDSigGen.nitro.ts +978 -0
  527. package/src/specs/Xmp.nitro.ts +364 -0
  528. package/src/specs/Zip.nitro.ts +1611 -0
  529. package/src/specs/ZipCrc.nitro.ts +229 -0
  530. package/src/specs/ZipEntry.nitro.ts +782 -0
@@ -0,0 +1,1988 @@
1
+ // Generated by ReactNativeNs.RnGenerator -- do not edit.
2
+ import type { HybridObject } from 'react-native-nitro-modules'
3
+ import type { BinData } from './BinData.nitro'
4
+ import type { StringBuilder } from './StringBuilder.nitro'
5
+
6
+ /**
7
+ * Load, navigate, search, edit, transform, and save in-memory XML trees.
8
+ *
9
+ * `Xml` is the primary Chilkat class for in-memory XML tree
10
+ * manipulation. It supports loading and saving XML, navigating between elements,
11
+ * reading and writing text content, managing attributes, working with
12
+ * namespaces, adding and removing subtrees, searching by tag, content, or
13
+ * attribute, sorting child records, scrubbing XML, handling CDATA and XML
14
+ * declarations, storing binary data as Base64, and optionally compressing or
15
+ * encrypting element content.
16
+ *
17
+ * **Load and save XML**
18
+ *
19
+ * Load XML from strings, files, byte data, or other Chilkat objects, then
20
+ * save or emit formatted XML when processing is complete.
21
+ *
22
+ * **Navigate XML trees**
23
+ *
24
+ * Move through parent, child, sibling, and selected elements while working
25
+ * directly with the XML document structure.
26
+ *
27
+ * **Edit elements and attributes**
28
+ *
29
+ * Add, update, remove, or rename elements; set text content; and read,
30
+ * add, modify, or delete attributes.
31
+ *
32
+ * **Search and select**
33
+ *
34
+ * Locate elements by tag name, content, path, attribute value, or custom
35
+ * search patterns.
36
+ *
37
+ * **Namespaces and structure**
38
+ *
39
+ * Work with namespace-aware XML, declarations, CDATA, child ordering,
40
+ * sorting, and subtree insertion or removal.
41
+ *
42
+ * **Binary and protected content**
43
+ *
44
+ * Store binary data as Base64 and optionally compress or encrypt element
45
+ * content when XML carries encoded payloads.
46
+ *
47
+ * **Important usage distinction:**
48
+ * Some methods return a new `Xml` object reference for the selected
49
+ * element, while methods ending in `2` update the caller's internal
50
+ * reference to point to a different element. This distinction is central when
51
+ * navigating and editing XML trees because it determines whether the current
52
+ * object stays where it is or moves to another element.
53
+ *
54
+ * **Common pattern:**
55
+ * Load or create the XML document, navigate to the element of interest, read or
56
+ * modify content and attributes, add or remove child elements as needed, then
57
+ * save the updated XML. Use `Xml` for tree-oriented XML
58
+ * manipulation, and use `XmlDSig`,
59
+ * `XmlDSigGen`, or related classes when the task is XML
60
+ * digital signing or signature verification.
61
+ *
62
+ * For an extended overview, see
63
+ * [Xml Class Overview](https://www.chilkatsoft.com/xml_class_overview.asp).
64
+ *
65
+ * Each `Xml` instance owns a native Chilkat object. It is released when the JavaScript object is
66
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
67
+ * Create one with `new Xml()`.
68
+ */
69
+ export interface Xml extends HybridObject<{ ios: 'c++', android: 'c++' }> {
70
+ // ---- Properties ----
71
+
72
+ /**
73
+ * Provides HTML-formatted information about the last called method or property. If a method call
74
+ * fails or behaves unexpectedly, check this property for details. Note that information is
75
+ * available regardless of the method call's success.
76
+ *
77
+ * This property is read-only.
78
+ */
79
+ readonly lastErrorHtml: string
80
+
81
+ /**
82
+ * Provides plain text information about the last called method or property. If a method call
83
+ * fails or behaves unexpectedly, check this property for details. Note that information is
84
+ * available regardless of the method call's success.
85
+ *
86
+ * This property is read-only.
87
+ */
88
+ readonly lastErrorText: string
89
+
90
+ /**
91
+ * Provides XML-formatted information about the last called method or property. If a method call
92
+ * fails or behaves unexpectedly, check this property for details. Note that information is
93
+ * available regardless of the method call's success.
94
+ *
95
+ * This property is read-only.
96
+ */
97
+ readonly lastErrorXml: string
98
+
99
+ /**
100
+ * Version of the component/library, such as "10.1.0"
101
+ *
102
+ * This property is read-only.
103
+ */
104
+ readonly version: string
105
+
106
+ /**
107
+ * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
108
+ * call to the specified file. This logging helps identify the context and history of Chilkat
109
+ * calls leading up to any crash or hang, aiding in debugging.
110
+ *
111
+ * Enabling the VerboseLogging property provides more detailed information.
112
+ *
113
+ * This property is mainly used for debugging rare instances where a Chilkat method call causes a
114
+ * hang or crash, which should generally not happen.
115
+ *
116
+ * Possible causes of hangs include:
117
+ *
118
+ * - A timeout property set to 0, indicating an infinite timeout.
119
+ *
120
+ * - A hang occurring within an event callback in the application code.
121
+ *
122
+ * - An internal bug in the Chilkat code causing the hang.
123
+ */
124
+ debugLogFilePath: string
125
+
126
+ /**
127
+ * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
128
+ * contain more verbose information. The default value is `false`. Verbose logging should only be
129
+ * used for debugging. The potentially large quantity of logged information may adversely affect
130
+ * peformance.
131
+ */
132
+ verboseLogging: boolean
133
+
134
+ /**
135
+ * Indicates the success or failure of the most recent method call: `true` means success, `false`
136
+ * means failure. This property remains unchanged by property setters or getters. This method is
137
+ * present to address challenges in checking for null or Nothing returns in certain programming
138
+ * languages. Note: This property does not apply to methods that return integer values or to
139
+ * boolean-returning methods where the boolean does not indicate success or failure.
140
+ */
141
+ lastMethodSuccess: boolean
142
+
143
+ /**
144
+ * Controls how this element's text content is emitted. When set to `true`, the element content is
145
+ * written inside a CDATA section instead of being emitted as ordinary character data with XML
146
+ * escaping.
147
+ *
148
+ * **CDATA and escaping:** CDATA is useful when text contains many characters such as `<` or `&`.
149
+ * It does not change the logical text value of the element; it only changes how that text is
150
+ * represented in the serialized XML.
151
+ */
152
+ cdata: boolean
153
+
154
+ /**
155
+ * Gets or sets the text content stored directly on this XML element. Child elements are not
156
+ * included in this value.
157
+ *
158
+ * For example, both of the following elements have `This is the content` as their `Content`:
159
+ *
160
+ * ```
161
+ * _LT_tag1_GT_This is the content_LT_/tag1_GT_
162
+ *
163
+ * _LT_tag2_GT__LT_child1_GT_abc_LT_/child1_GT__LT_child2_GT_abc_LT_/child2_GT_This is the content_LT_/tag2_GT_
164
+ * ```
165
+ *
166
+ * **Content vs. children:** Chilkat stores an element's direct text content separately from its
167
+ * child elements. Use the child-navigation methods when you need the nested elements themselves.
168
+ */
169
+ content: string
170
+
171
+ /**
172
+ * Gets or sets this element's content as a 32-bit integer. Setting the property converts the
173
+ * integer to its decimal text representation; getting the property interprets the element's text
174
+ * content as an integer.
175
+ *
176
+ * **Numeric content:** Use `Content` when the value may exceed the range of a 32-bit integer or
177
+ * when the exact lexical representation must be preserved.
178
+ */
179
+ contentInt: number
180
+
181
+ /**
182
+ * Gets or sets the document type declaration associated with the XML document.
183
+ *
184
+ * The value represents the document-level `DOCTYPE` declaration, for example `_LT_!DOCTYPE note
185
+ * SYSTEM "note.dtd"_GT_`.
186
+ *
187
+ * **Document-level setting:** Although this property may be accessed from any element reference
188
+ * in the tree, the DOCTYPE belongs to the XML document as a whole rather than to an individual
189
+ * element.
190
+ */
191
+ docType: string
192
+
193
+ /**
194
+ * Controls whether a byte order mark (BOM, also called a preamble) is written when XML is saved
195
+ * to a file. The default is `false`.
196
+ *
197
+ * This setting is relevant to encodings for which a BOM can be emitted, such as UTF-8 and UTF-16.
198
+ * It does not affect XML returned as a language string by methods such as `GetXml`.
199
+ */
200
+ emitBom: boolean
201
+
202
+ /**
203
+ * Controls whether the XML declaration is included when XML is emitted. The default is `true`.
204
+ * When set to `false`, output methods such as `GetXml` and `SaveXml` omit the declaration.
205
+ *
206
+ * An XML declaration is the leading construct such as `_LT_?xml version="1.0"
207
+ * encoding="utf-8"?_GT_`.
208
+ */
209
+ emitXmlDecl: boolean
210
+
211
+ /**
212
+ * Gets or sets the `encoding` value used in the XML declaration. The default is `utf-8`. This is
213
+ * a document-level setting and may be accessed from any element in the tree.
214
+ *
215
+ * When XML is loaded, Chilkat sets this property from the encoding declared by the input XML when
216
+ * one is present. If no encoding is declared, the property is reset to `utf-8`.
217
+ *
218
+ * **Important:** Changing `Encoding` changes the declared/output encoding used when XML is
219
+ * serialized; it does not reinterpret or transcode the already-stored Unicode text inside the
220
+ * in-memory tree.
221
+ */
222
+ encoding: string
223
+
224
+ /**
225
+ * Returns the number of attributes on this element.
226
+ *
227
+ * For example, `_LT_tag attr1="value1" attr2="value2"_GT_..._LT_/tag_GT_` has two attributes.
228
+ * Attribute indexes used by methods such as `GetAttributeName` and `GetAttributeValue` are
229
+ * zero-based.
230
+ *
231
+ * This property is read-only.
232
+ */
233
+ readonly numAttributes: number
234
+
235
+ /**
236
+ * Returns the number of direct child elements of this element. Descendants below those children
237
+ * are not included in the count.
238
+ *
239
+ * **Direct children only:** Use traversal or search methods when you need to inspect the entire
240
+ * subtree rather than only the immediate children.
241
+ *
242
+ * This property is read-only.
243
+ */
244
+ readonly numChildren: number
245
+
246
+ /**
247
+ * Controls case sensitivity for the XML sorting methods. Set to `true` for case-insensitive
248
+ * string comparisons or `false` for case-sensitive comparisons.
249
+ */
250
+ sortCaseInsensitive: boolean
251
+
252
+ /**
253
+ * Controls the `standalone` pseudo-attribute in the XML declaration. This is a document-level
254
+ * setting and may be accessed from any element in the tree.
255
+ *
256
+ * Setting this property to `true` causes the declaration to include `standalone="yes"`.
257
+ *
258
+ * **XML declaration:** The standalone declaration concerns whether the document relies on
259
+ * external markup declarations. It is metadata in the XML declaration; it does not by itself
260
+ * validate or alter the document.
261
+ */
262
+ standalone: boolean
263
+
264
+ /**
265
+ * When `Strict` is **true**, the XML loading methods first check that the input is well-formed
266
+ * XML. If it is not, the load fails and the contents of this Xml object are left **unchanged**.
267
+ * The default is `false`.
268
+ *
269
+ * This applies to {@link Xml.loadXml}, {@link Xml.loadXml2}, {@link Xml.loadSb}, {@link
270
+ * Xml.loadBd}, {@link Xml.loadXmlFile} and {@link Xml.loadXmlFile2}.
271
+ *
272
+ * Chilkat's XML parser is deliberately tolerant. By default it can accept input that is not
273
+ * well-formed, succeed, and leave a partially populated tree. That is convenient when the goal is
274
+ * a best-effort parse of imperfect input, but it is the wrong behavior when a silently dropped
275
+ * element or attribute changes what the application does.
276
+ *
277
+ * Set `Strict` to `true` for XML carrying configuration, credentials, signed content, or security
278
+ * parameters, where an element that quietly failed to load would be acted on as though it had
279
+ * never been present.
280
+ *
281
+ * The check is for XML 1.0 **well-formedness** only. It is not a validating parse: no DTD or
282
+ * schema is read, and the document is not checked against one. Markup declarations inside an
283
+ * internal DTD subset are skipped rather than parsed.
284
+ *
285
+ * **Note:** The default is `false` so that existing applications are unaffected. When a strict
286
+ * load is rejected, this Xml object keeps whatever it held before the call, so a failed reload
287
+ * never leaves the object empty.
288
+ */
289
+ strict: boolean
290
+
291
+ /**
292
+ * Gets or sets the element name for this element, including any namespace prefix. For example,
293
+ * the tag for `_LT_soapenv:Body_GT_` is `soapenv:Body`.
294
+ *
295
+ * Use `TagNsPrefix` and `TagUnprefixed` when the prefix and local portion are needed separately.
296
+ */
297
+ tag: string
298
+
299
+ /**
300
+ * Returns the identifier of the XML tree to which this element belongs. Elements in the same XML
301
+ * document have the same `TreeId`.
302
+ *
303
+ * **Useful for element references:** Multiple `Xml` objects can reference different elements in
304
+ * the same underlying tree. Comparing `TreeId` values is a convenient way to determine whether
305
+ * two element references belong to that same tree.
306
+ *
307
+ * This property is read-only.
308
+ */
309
+ readonly treeId: number
310
+
311
+ /**
312
+ * Provides a substitution value for `[i]` in Chilkat tag paths and `ChilkatPath` expressions.
313
+ * When a path contains `[i]`, the current value of this property is substituted for I.
314
+ *
315
+ * **Loop-friendly paths:** The `I`, `J`, and `K` properties make it convenient to reuse a path
316
+ * expression inside nested loops without constructing a new path string for every index.
317
+ */
318
+ i: number
319
+
320
+ /**
321
+ * Provides a substitution value for `[j]` in Chilkat tag paths and `ChilkatPath` expressions.
322
+ * When a path contains `[j]`, the current value of this property is substituted for J.
323
+ *
324
+ * **Loop-friendly paths:** The `I`, `J`, and `K` properties make it convenient to reuse a path
325
+ * expression inside nested loops without constructing a new path string for every index.
326
+ */
327
+ j: number
328
+
329
+ /**
330
+ * Provides a substitution value for `[k]` in Chilkat tag paths and `ChilkatPath` expressions.
331
+ * When a path contains `[k]`, the current value of this property is substituted for K.
332
+ *
333
+ * **Loop-friendly paths:** The `I`, `J`, and `K` properties make it convenient to reuse a path
334
+ * expression inside nested loops without constructing a new path string for every index.
335
+ */
336
+ k: number
337
+
338
+ /**
339
+ * Controls whether XML emitted by `GetXml` and `GetXmlSb` is compact. When `true`, unnecessary
340
+ * formatting whitespace and line breaks are omitted. The default is `false` for backward
341
+ * compatibility.
342
+ *
343
+ * **Formatting only:** Compact output changes presentation, not the XML tree or its element
344
+ * content.
345
+ */
346
+ emitCompact: boolean
347
+
348
+ /**
349
+ * Returns `true` if this element's content consists only of characters allowed in standard Base64
350
+ * text, with whitespace ignored. Standard Base64 uses `A-Z`, `a-z`, `0-9`, `+`, `/`, and optional
351
+ * trailing `=` padding.
352
+ *
353
+ * **Syntax check, not semantic validation:** A value can contain only Base64 characters and still
354
+ * not represent the data your application expects. This property is useful as a quick
355
+ * content-format test.
356
+ *
357
+ * This property is read-only.
358
+ */
359
+ readonly isBase64: boolean
360
+
361
+ /**
362
+ * Gets or sets the namespace prefix portion of this element's tag. For `soapenv:Envelope`, the
363
+ * namespace prefix is `soapenv`.
364
+ *
365
+ * **Prefix vs. namespace URI:** This property deals with the lexical prefix in the tag name. A
366
+ * prefix is not itself the namespace URI; namespace bindings are expressed through `xmlns`
367
+ * attributes in the XML.
368
+ */
369
+ tagNsPrefix: string
370
+
371
+ /**
372
+ * Gets or sets the unprefixed portion of this element's tag. For `soapenv:Envelope`, the
373
+ * unprefixed tag is `Envelope`.
374
+ *
375
+ * Use `TagNsPrefix` to access the prefix separately.
376
+ */
377
+ tagUnprefixed: string
378
+
379
+ /**
380
+ * Returns the Chilkat tag path needed to reach this element from the document root. If this
381
+ * object currently references the root element, the returned path is the empty string.
382
+ *
383
+ * **Not XPath:** A Chilkat tag path is Chilkat's own navigation syntax, typically using `|`
384
+ * between element names. It is not an XPath expression.
385
+ *
386
+ * This property is read-only.
387
+ */
388
+ readonly tagPath: string
389
+
390
+ /**
391
+ * Provides a catch-all string for uncommon XML behaviors. The default is the empty string, which
392
+ * is appropriate for normal use.
393
+ *
394
+ * Leave this property empty unless Chilkat documentation or support identifies a specific option
395
+ * needed for a specialized interoperability case.
396
+ */
397
+ uncommonOptions: string
398
+
399
+ // ---- Methods ----
400
+
401
+ /**
402
+ * Traverses the subtree rooted at the calling element and concatenates the text content of all
403
+ * elements whose tag equals `tag`.
404
+ *
405
+ * `skipTags` is a vertical-bar-delimited list of tag names whose entire subtrees are excluded
406
+ * from the accumulation. For example, `script|style` skips elements rooted at either of those
407
+ * tags.
408
+ *
409
+ * @throws Error if the call fails (the message names the reason); the full log is in
410
+ * {@link Xml.lastErrorText}.
411
+ */
412
+ accumulateTagContent(tag: string, skipTags: string): string
413
+
414
+ /**
415
+ * Adds an attribute named `name` with the specified string `value` to the calling element.
416
+ *
417
+ * Returns `true` on success and `false` on failure.
418
+ *
419
+ * **When an attribute may already exist:** Use `AddOrUpdateAttribute` or `UpdateAttribute` when
420
+ * the desired behavior is to update an existing attribute value instead of requiring a new
421
+ * attribute.
422
+ *
423
+ * @throws Error if the call fails (the message names the reason); the full log is in
424
+ * {@link Xml.lastErrorText}.
425
+ */
426
+ addAttribute(name: string, value: string): void
427
+
428
+ /**
429
+ * Adds an attribute named `name` whose value is the decimal representation of `value`.
430
+ *
431
+ * Returns `true` on success and `false` on failure.
432
+ *
433
+ * @throws Error if the call fails (the message names the reason); the full log is in
434
+ * {@link Xml.lastErrorText}.
435
+ */
436
+ addAttributeInt(name: string, value: number): void
437
+
438
+ /**
439
+ * Adds the entire XML subtree referenced by `tree` as a new direct child of the calling element.
440
+ *
441
+ * If `tree` already belongs to another XML document, the subtree is transferred to the
442
+ * destination tree rather than copied as an unrelated duplicate.
443
+ *
444
+ * **Tree ownership:** After moving a subtree between documents, its elements belong to the
445
+ * destination tree. `TreeId` can be used to determine which tree an element reference belongs to.
446
+ *
447
+ * @throws Error if the call fails (the message names the reason); the full log is in
448
+ * {@link Xml.lastErrorText}.
449
+ */
450
+ addChildTree(tree: Xml): void
451
+
452
+ /**
453
+ * Sets the string value of an attribute on the calling element. If an attribute named `name`
454
+ * already exists, its value is replaced; otherwise the attribute is added.
455
+ */
456
+ addOrUpdateAttribute(name: string, value: string): void
457
+
458
+ /**
459
+ * Sets an integer-valued attribute on the calling element. If an attribute named `name` already
460
+ * exists, its value is replaced with the decimal representation of `value`; otherwise the
461
+ * attribute is added.
462
+ */
463
+ addOrUpdateAttributeI(name: string, value: number): void
464
+
465
+ /**
466
+ * Adds an XML stylesheet processing instruction to the document. Pass the complete
467
+ * processing-instruction text, for example:
468
+ *
469
+ * ```
470
+ * _LT_?xml-stylesheet href="mystyle.css" title="Compact" type="text/css"?_GT_
471
+ * ```
472
+ *
473
+ * **Processing instruction:** An XML stylesheet declaration associates stylesheet metadata with
474
+ * the XML document; it does not apply or execute the stylesheet.
475
+ */
476
+ addStyleSheet(styleSheet: string): void
477
+
478
+ /**
479
+ * Treats the named attribute value as an integer, adds `amount`, and stores the resulting integer
480
+ * back in the attribute.
481
+ *
482
+ * If the attribute does not yet exist, this method behaves like `AddOrUpdateAttributeI` and
483
+ * creates it with `amount` as the value.
484
+ */
485
+ addToAttribute(name: string, amount: number): void
486
+
487
+ /**
488
+ * Finds the child identified by `tag`, interprets its content as an integer, adds `amount`, and
489
+ * stores the resulting integer as the child's new content.
490
+ */
491
+ addToChildContent(tag: string, amount: number): void
492
+
493
+ /**
494
+ * Interprets this element's content as an integer, adds `amount`, and stores the resulting
495
+ * integer as the new content.
496
+ */
497
+ addToContent(amount: number): void
498
+
499
+ /**
500
+ * Appends `str` to the existing text content of the calling element without replacing its child
501
+ * elements.
502
+ *
503
+ * Returns `true` on success and `false` on failure.
504
+ *
505
+ * @throws Error if the call fails (the message names the reason); the full log is in
506
+ * {@link Xml.lastErrorText}.
507
+ */
508
+ appendToContent(str: string): void
509
+
510
+ /**
511
+ * Returns `true` if the child identified by `tagPath` has content matching `pattern`; otherwise
512
+ * returns `false`. `caseSensitive` controls whether letter case is significant.
513
+ *
514
+ * The pattern may contain `*` wildcards, where each asterisk matches zero or more characters.
515
+ *
516
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
517
+ * `tagA|tagB|tagC`. It is not XPath.
518
+ */
519
+ childContentMatches(tagPath: string, pattern: string, caseSensitive: boolean): boolean
520
+
521
+ /**
522
+ * Evaluates a Chilkat-specific path command that can navigate from the current element, return
523
+ * element content or an attribute value, or move the caller's internal element reference.
524
+ *
525
+ * **This syntax is not XPath.** Commands are separated by vertical bars and the expression ends
526
+ * with a return command:
527
+ *
528
+ * ```
529
+ * command|command|command|...|returnCommand
530
+ * ```
531
+ *
532
+ * Navigation commands include:
533
+ *
534
+ * - `TagName` - first direct child having that tag.
535
+ *
536
+ * - `TagName[n]` - the indexed direct child having that tag.
537
+ *
538
+ * - `..` - parent.
539
+ *
540
+ * - `++` / `--` - next / previous sibling.
541
+ *
542
+ * - `TagName{Content}` - first direct child with that tag and exact content.
543
+ *
544
+ * - `/T/TagName` - traverse the subtree and find the first element with that tag.
545
+ *
546
+ * - `/C/TagName,ContentPattern` - traverse for a tag whose content matches a wildcard pattern.
547
+ *
548
+ * - `/C/ContentPattern` - traverse for any tag whose content matches a wildcard pattern.
549
+ *
550
+ * - `/A/TagName,AttrName,AttrValuePattern` - traverse for a tag having a matching attribute
551
+ * value.
552
+ *
553
+ * The final return command is:
554
+ *
555
+ * - `*` - return the current element's content.
556
+ *
557
+ * - `(AttrName)` - return an attribute value.
558
+ *
559
+ * - `$` - move this `Xml` object to the selected element and return an empty string.
560
+ *
561
+ * **Index substitution:** The `I`, `J`, and `K` properties can be used with `[i]`, `[j]`, and
562
+ * `[k]` in path expressions.
563
+ *
564
+ * @throws Error if the call fails (the message names the reason); the full log is in
565
+ * {@link Xml.lastErrorText}.
566
+ */
567
+ chilkatPath(pathCmd: string): string
568
+
569
+ /**
570
+ * Clears the calling element by removing all child elements, attributes, and text content, and
571
+ * resets its tag name to `unnamed`.
572
+ *
573
+ * The element itself remains in the tree; this method clears its contents rather than removing
574
+ * the element from its parent.
575
+ */
576
+ clear(): void
577
+
578
+ /**
579
+ * Returns `true` if this element's content matches `pattern`; otherwise returns `false`.
580
+ * `caseSensitive` controls whether letter case is significant.
581
+ *
582
+ * The pattern may contain `*` wildcards, where each asterisk matches zero or more characters.
583
+ */
584
+ contentMatches(pattern: string, caseSensitive: boolean): boolean
585
+
586
+ /**
587
+ * Copies the `Tag`, `Content`, and attributes from `node` to the calling element.
588
+ *
589
+ * **Not a subtree copy:** This method does not copy the source element's children. Use a
590
+ * tree-oriented method such as `AddChildTree` or `SwapTree` when child structure is part of the
591
+ * operation.
592
+ */
593
+ copy(node: Xml): void
594
+
595
+ /**
596
+ * Changes this `Xml` object so that it references the same underlying XML element as
597
+ * `copyFromNode`. The caller's previous element reference is discarded.
598
+ *
599
+ * **Reference operation:** `CopyRef` does not copy XML data. After the call, both `Xml` objects
600
+ * refer to the same element, so edits through either reference affect the same tree element.
601
+ */
602
+ copyRef(copyFromNode: Xml): void
603
+
604
+ /**
605
+ * Decodes HTML character entities found in `str` and returns the decoded text. This is a utility
606
+ * operation; it does not modify the XML tree unless the returned string is assigned to an
607
+ * element.
608
+ *
609
+ * For example, an HTML entity such as `&amp;` is decoded to `&`.
610
+ *
611
+ * @throws Error if the call fails (the message names the reason); the full log is in
612
+ * {@link Xml.lastErrorText}.
613
+ */
614
+ decodeEntities(str: string): string
615
+
616
+ /**
617
+ * Decrypts element content previously produced by `EncryptContent`, using the same password, and
618
+ * restores the original plaintext content.
619
+ *
620
+ * Returns `true` on success and `false` on failure.
621
+ *
622
+ * **Compatibility-oriented encryption:** This method is paired specifically with
623
+ * `EncryptContent`. It is not a general XML Encryption (XML-Enc) implementation.
624
+ *
625
+ * @throws Error if the call fails (the message names the reason); the full log is in
626
+ * {@link Xml.lastErrorText}.
627
+ */
628
+ decryptContent(password: string): void
629
+
630
+ /**
631
+ * Encrypts the calling element's text content using Chilkat's password-based 128-bit AES-CBC
632
+ * format and replaces the plaintext content with Base64-encoded encrypted data.
633
+ *
634
+ * Returns `true` on success and `false` on failure.
635
+ *
636
+ * **Scope:** Only this element's content is encrypted. The tag, attributes, and child elements
637
+ * are not encrypted by this method. Use `DecryptContent` with the same password to restore the
638
+ * content.
639
+ *
640
+ * @throws Error if the call fails (the message names the reason); the full log is in
641
+ * {@link Xml.lastErrorText}.
642
+ */
643
+ encryptContent(password: string): void
644
+
645
+ /**
646
+ * Removes the direct child at zero-based `index` from the calling element and returns an `Xml`
647
+ * object for the detached child subtree.
648
+ *
649
+ * **Extract vs. remove:** Unlike `RemoveChildByIndex`, extraction gives the caller a reference to
650
+ * the removed subtree so it can be retained, inspected, or attached elsewhere.
651
+ *
652
+ * @throws Error if the call fails (the message names the reason); the full log is in
653
+ * {@link Xml.lastErrorText}.
654
+ */
655
+ extractChildByIndex(index: number): Xml
656
+
657
+ /**
658
+ * Finds, removes, and returns the first child selected by `tagPath` and the optional attribute
659
+ * criteria.
660
+ *
661
+ * If `attrName` and `attrValue` are empty, the first child matching the tag/path is extracted. If
662
+ * `attrName` is provided, the child must have that attribute. If `attrValue` is also provided,
663
+ * the attribute value must match exactly.
664
+ *
665
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
666
+ * `tagA|tagB|tagC`. It is not XPath.
667
+ *
668
+ * @throws Error if the call fails (the message names the reason); the full log is in
669
+ * {@link Xml.lastErrorText}.
670
+ */
671
+ extractChildByName(tagPath: string, attrName: string, attrValue: string): Xml
672
+
673
+ /**
674
+ * Returns an `Xml` object referencing the child selected by `tagPath`. The calling object remains
675
+ * positioned on its current element.
676
+ *
677
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
678
+ * `tagA|tagB|tagC`. It is not XPath.
679
+ *
680
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
681
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
682
+ * the caller's internal reference.
683
+ *
684
+ * @throws Error if the call fails (the message names the reason); the full log is in
685
+ * {@link Xml.lastErrorText}.
686
+ */
687
+ findChild(tagPath: string): Xml
688
+
689
+ /**
690
+ * Moves the calling `Xml` object's internal reference to the child selected by `tagPath`. Returns
691
+ * `true` when the child is found and the move succeeds; otherwise returns `false`.
692
+ *
693
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
694
+ * `tagA|tagB|tagC`. It is not XPath.
695
+ *
696
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
697
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
698
+ * the caller's internal reference.
699
+ *
700
+ * @throws Error if the call fails (the message names the reason); the full log is in
701
+ * {@link Xml.lastErrorText}.
702
+ */
703
+ findChild2(tagPath: string): void
704
+
705
+ /**
706
+ * Finds the next direct child record for which the descendant identified by `tagPath` has content
707
+ * matching `contentPattern`. This is intended for iterating record-like child elements.
708
+ *
709
+ * The content pattern may contain `*` wildcards.
710
+ *
711
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
712
+ * `tagA|tagB|tagC`. It is not XPath.
713
+ *
714
+ * @throws Error if the call fails (the message names the reason); the full log is in
715
+ * {@link Xml.lastErrorText}.
716
+ */
717
+ findNextRecord(tagPath: string, contentPattern: string): Xml
718
+
719
+ /**
720
+ * Returns the child selected by `tagPath` if it already exists. If it does not exist, creates the
721
+ * required child path with empty content and returns the resulting child element.
722
+ *
723
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
724
+ * `tagA|tagB|tagC`. It is not XPath. Use `NewChild` instead when duplicate children with the same
725
+ * tag are intentional.
726
+ *
727
+ * @throws Error if the call fails (the message names the reason); the full log is in
728
+ * {@link Xml.lastErrorText}.
729
+ */
730
+ findOrAddNewChild(tagPath: string): Xml
731
+
732
+ /**
733
+ * Returns an `Xml` object referencing the first direct child of the calling element.
734
+ *
735
+ * A common forward-iteration pattern is `FirstChild` followed by repeated calls to `NextSibling`.
736
+ *
737
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
738
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
739
+ * the caller's internal reference.
740
+ *
741
+ * @throws Error if the call fails (the message names the reason); the full log is in
742
+ * {@link Xml.lastErrorText}.
743
+ */
744
+ firstChild(): Xml
745
+
746
+ /**
747
+ * Moves the calling `Xml` object's internal reference to its first direct child. Returns `true`
748
+ * if a first child exists; otherwise returns `false`.
749
+ *
750
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
751
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
752
+ * the caller's internal reference.
753
+ */
754
+ firstChild2(): boolean
755
+
756
+ /**
757
+ * Returns the value of the attribute named `name` on the calling element.
758
+ *
759
+ * Use `HasAttribute` when the application must distinguish a missing attribute from an attribute
760
+ * whose value is empty.
761
+ *
762
+ * @throws Error if the call fails (the message names the reason); the full log is in
763
+ * {@link Xml.lastErrorText}.
764
+ */
765
+ getAttrValue(name: string): string
766
+
767
+ /**
768
+ * Returns the value of the attribute named `name` interpreted as a 32-bit integer. Returns `0` if
769
+ * the attribute does not exist.
770
+ *
771
+ * **Ambiguous zero:** Because a missing attribute and an attribute containing zero can both yield
772
+ * `0`, call `HasAttribute` first when that distinction matters.
773
+ */
774
+ getAttrValueInt(name: string): number
775
+
776
+ /**
777
+ * Returns the name of the attribute at zero-based `index`. Use `NumAttributes` to determine the
778
+ * valid index range.
779
+ *
780
+ * @throws Error if the call fails (the message names the reason); the full log is in
781
+ * {@link Xml.lastErrorText}.
782
+ */
783
+ getAttributeName(index: number): string
784
+
785
+ /**
786
+ * Returns the value of the attribute at zero-based `index`. Use `NumAttributes` to determine the
787
+ * valid index range.
788
+ *
789
+ * @throws Error if the call fails (the message names the reason); the full log is in
790
+ * {@link Xml.lastErrorText}.
791
+ */
792
+ getAttributeValue(index: number): string
793
+
794
+ /**
795
+ * Returns the value of the attribute at zero-based `index`, interpreted as a 32-bit integer.
796
+ */
797
+ getAttributeValueInt(index: number): number
798
+
799
+ /**
800
+ * Returns an `Xml` object referencing the direct child at zero-based `index`. The calling object
801
+ * remains positioned on its current element.
802
+ *
803
+ * Use `NumChildren` to determine the valid child range.
804
+ *
805
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
806
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
807
+ * the caller's internal reference.
808
+ *
809
+ * @throws Error if the call fails (the message names the reason); the full log is in
810
+ * {@link Xml.lastErrorText}.
811
+ */
812
+ getChild(index: number): Xml
813
+
814
+ /**
815
+ * Moves the calling `Xml` object's internal reference to the direct child at zero-based `index`.
816
+ * Returns `true` on success and `false` if the child cannot be selected.
817
+ *
818
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
819
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
820
+ * the caller's internal reference.
821
+ *
822
+ * @throws Error if the call fails (the message names the reason); the full log is in
823
+ * {@link Xml.lastErrorText}.
824
+ */
825
+ getChild2(index: number): void
826
+
827
+ /**
828
+ * Returns the integer content of the child selected by `tagPath` as a Boolean value: content
829
+ * equal to `0` yields `false`; a non-zero integer yields `true`.
830
+ *
831
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
832
+ * `tagA|tagB|tagC`. It is not XPath.
833
+ */
834
+ getChildBoolValue(tagPath: string): boolean
835
+
836
+ /**
837
+ * Returns the text content of the child selected by `tagPath`.
838
+ *
839
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
840
+ * `tagA|tagB|tagC`. It is not XPath.
841
+ *
842
+ * **Content only:** The returned value is the child element's direct `Content`; nested child
843
+ * elements are not serialized into this string.
844
+ *
845
+ * @throws Error if the call fails (the message names the reason); the full log is in
846
+ * {@link Xml.lastErrorText}.
847
+ */
848
+ getChildContent(tagPath: string): string
849
+
850
+ /**
851
+ * Returns the text content of the direct child at zero-based `index`. Use `NumChildren` to
852
+ * determine the valid range.
853
+ *
854
+ * @throws Error if the call fails (the message names the reason); the full log is in
855
+ * {@link Xml.lastErrorText}.
856
+ */
857
+ getChildContentByIndex(index: number): string
858
+
859
+ /**
860
+ * Returns the first direct child whose tag equals `tag` and whose text content exactly equals
861
+ * `content`.
862
+ *
863
+ * The calling object remains positioned on its current element.
864
+ *
865
+ * @throws Error if the call fails (the message names the reason); the full log is in
866
+ * {@link Xml.lastErrorText}.
867
+ */
868
+ getChildExact(tag: string, content: string): Xml
869
+
870
+ /**
871
+ * Returns the content of the child selected by `tagPath`, interpreted as a 32-bit integer.
872
+ *
873
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
874
+ * `tagA|tagB|tagC`. It is not XPath.
875
+ *
876
+ * **Integer range:** Use `GetChildContent` and parse the returned text separately when values may
877
+ * exceed the range of a 32-bit integer.
878
+ */
879
+ getChildIntValue(tagPath: string): number
880
+
881
+ /**
882
+ * Returns the tag name of the direct child at zero-based `index`. Use `NumChildren` to determine
883
+ * the valid index range.
884
+ *
885
+ * @throws Error if the call fails (the message names the reason); the full log is in
886
+ * {@link Xml.lastErrorText}.
887
+ */
888
+ getChildTag(index: number): string
889
+
890
+ /**
891
+ * Returns the tag name of the direct child at zero-based `index`. Use `NumChildren` to determine
892
+ * the valid index range.
893
+ *
894
+ * @throws Error if the call fails (the message names the reason); the full log is in
895
+ * {@link Xml.lastErrorText}.
896
+ */
897
+ getChildTagByIndex(index: number): string
898
+
899
+ /**
900
+ * Returns the child selected by `tagPath` that also has an attribute named `attrName` whose value
901
+ * exactly equals `attrValue`.
902
+ *
903
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
904
+ * `tagA|tagB|tagC`. It is not XPath.
905
+ *
906
+ * @throws Error if the call fails (the message names the reason); the full log is in
907
+ * {@link Xml.lastErrorText}.
908
+ */
909
+ getChildWithAttr(tagPath: string, attrName: string, attrValue: string): Xml
910
+
911
+ /**
912
+ * Returns the first direct child whose text content exactly equals `content`. The child tag may
913
+ * be any value.
914
+ *
915
+ * @throws Error if the call fails (the message names the reason); the full log is in
916
+ * {@link Xml.lastErrorText}.
917
+ */
918
+ getChildWithContent(content: string): Xml
919
+
920
+ /**
921
+ * Returns an `Xml` object referencing the child selected by `tagPath`. The calling object remains
922
+ * positioned on its current element.
923
+ *
924
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
925
+ * `tagA|tagB|tagC`. It is not XPath.
926
+ *
927
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
928
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
929
+ * the caller's internal reference.
930
+ *
931
+ * @throws Error if the call fails (the message names the reason); the full log is in
932
+ * {@link Xml.lastErrorText}.
933
+ */
934
+ getChildWithTag(tagPath: string): Xml
935
+
936
+ /**
937
+ * Returns the zero-based `n`th direct child whose tag exactly equals `tag`. Children with other
938
+ * tag names are ignored when counting matches.
939
+ *
940
+ * Use `NumChildrenHavingTag` to determine how many matching children are available.
941
+ *
942
+ * @throws Error if the call fails (the message names the reason); the full log is in
943
+ * {@link Xml.lastErrorText}.
944
+ */
945
+ getNthChildWithTag(tag: string, n: number): Xml
946
+
947
+ /**
948
+ * Moves the calling `Xml` object's internal reference to the zero-based `n`th direct child whose
949
+ * tag equals `tag`. Returns `true` on success and `false` when no such child exists.
950
+ *
951
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
952
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
953
+ * the caller's internal reference.
954
+ *
955
+ * @throws Error if the call fails (the message names the reason); the full log is in
956
+ * {@link Xml.lastErrorText}.
957
+ */
958
+ getNthChildWithTag2(tag: string, n: number): void
959
+
960
+ /**
961
+ * Returns an `Xml` object referencing this element's parent. Returns no parent when the current
962
+ * element is the document root.
963
+ *
964
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
965
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
966
+ * the caller's internal reference.
967
+ *
968
+ * @throws Error if the call fails (the message names the reason); the full log is in
969
+ * {@link Xml.lastErrorText}.
970
+ */
971
+ getParent(): Xml
972
+
973
+ /**
974
+ * Moves the calling `Xml` object's internal reference to its parent. Returns `true` if a parent
975
+ * exists; otherwise returns `false` when already at the root.
976
+ *
977
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
978
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
979
+ * the caller's internal reference.
980
+ *
981
+ * @throws Error if the call fails (the message names the reason); the full log is in
982
+ * {@link Xml.lastErrorText}.
983
+ */
984
+ getParent2(): void
985
+
986
+ /**
987
+ * Returns an `Xml` object referencing the root element of the XML tree that contains the current
988
+ * element. The calling object remains positioned on its current element.
989
+ *
990
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
991
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
992
+ * the caller's internal reference.
993
+ *
994
+ * @throws Error if the call fails (the message names the reason); the full log is in
995
+ * {@link Xml.lastErrorText}.
996
+ */
997
+ getRoot(): Xml
998
+
999
+ /**
1000
+ * Moves the calling `Xml` object's internal reference to the root element of its XML tree.
1001
+ *
1002
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1003
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1004
+ * the caller's internal reference.
1005
+ */
1006
+ getRoot2(): void
1007
+
1008
+ /**
1009
+ * Returns a new `Xml` object that references the same underlying XML element as the calling
1010
+ * object.
1011
+ *
1012
+ * **Shared element reference:** This is not a deep copy. Both objects reference the same element,
1013
+ * so changes made through either object are changes to the same XML tree.
1014
+ *
1015
+ * @throws Error if the call fails (the message names the reason); the full log is in
1016
+ * {@link Xml.lastErrorText}.
1017
+ */
1018
+ getSelf(): Xml
1019
+
1020
+ /**
1021
+ * Serializes the XML tree or subtree rooted at the current element and returns the XML text.
1022
+ *
1023
+ * When called while positioned on the document root, the XML declaration is included if
1024
+ * `EmitXmlDecl` is `true`. When called on a non-root element, only that subtree is emitted and
1025
+ * the document declaration is not included.
1026
+ *
1027
+ * `EmitCompact`, `Encoding`, `Standalone`, and related document/output properties affect
1028
+ * serialization as applicable.
1029
+ *
1030
+ * **String vs. bytes:** A language string is Unicode text. The `Encoding` declaration describes
1031
+ * serialized XML encoding, while actual byte encoding matters when XML is written to a file or
1032
+ * byte-oriented destination.
1033
+ *
1034
+ * @throws Error if the call fails (the message names the reason); the full log is in
1035
+ * {@link Xml.lastErrorText}.
1036
+ */
1037
+ getXml(): string
1038
+
1039
+ /**
1040
+ * Returns `true` if the calling element has an attribute named `name` whose value exactly equals
1041
+ * `value`; otherwise returns `false`.
1042
+ */
1043
+ hasAttrWithValue(name: string, value: string): boolean
1044
+
1045
+ /**
1046
+ * Returns `true` if the calling element has an attribute named `name`; otherwise returns `false`.
1047
+ */
1048
+ hasAttribute(name: string): boolean
1049
+
1050
+ /**
1051
+ * Returns `true` if any direct child has text content exactly equal to `content`; otherwise
1052
+ * returns `false`.
1053
+ */
1054
+ hasChildWithContent(content: string): boolean
1055
+
1056
+ /**
1057
+ * Returns `true` if the child selected by `tagPath` exists; otherwise returns `false`.
1058
+ *
1059
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1060
+ * `tagA|tagB|tagC`. It is not XPath.
1061
+ */
1062
+ hasChildWithTag(tagPath: string): boolean
1063
+
1064
+ /**
1065
+ * Returns `true` if the child selected by `tagPath` exists and its text content exactly equals
1066
+ * `content`; otherwise returns `false`.
1067
+ *
1068
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1069
+ * `tagA|tagB|tagC`. It is not XPath.
1070
+ */
1071
+ hasChildWithTagAndContent(tagPath: string, content: string): boolean
1072
+
1073
+ /**
1074
+ * Inserts the entire subtree referenced by `tree` as a direct child immediately after the
1075
+ * existing child at zero-based `index`.
1076
+ *
1077
+ * If `tree` belongs to another XML document, the subtree is transferred to the destination tree.
1078
+ *
1079
+ * **Structural move:** The operation preserves the subtree structure. The supplied tree is not
1080
+ * flattened into text content.
1081
+ */
1082
+ insertChildTreeAfter(index: number, tree: Xml): void
1083
+
1084
+ /**
1085
+ * Inserts the entire subtree referenced by `tree` as a direct child immediately before the
1086
+ * existing child at zero-based `index`.
1087
+ *
1088
+ * If `tree` belongs to another XML document, the subtree is transferred to the destination tree.
1089
+ *
1090
+ * **Structural move:** The operation preserves the subtree structure. The supplied tree is not
1091
+ * flattened into text content.
1092
+ */
1093
+ insertChildTreeBefore(index: number, tree: Xml): void
1094
+
1095
+ /**
1096
+ * Returns an `Xml` object referencing the last direct child of the calling element.
1097
+ *
1098
+ * A common reverse-iteration pattern is `LastChild` followed by repeated calls to
1099
+ * `PreviousSibling`.
1100
+ *
1101
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1102
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1103
+ * the caller's internal reference.
1104
+ *
1105
+ * @throws Error if the call fails (the message names the reason); the full log is in
1106
+ * {@link Xml.lastErrorText}.
1107
+ */
1108
+ lastChild(): Xml
1109
+
1110
+ /**
1111
+ * Moves the calling `Xml` object's internal reference to its last direct child. Returns `true` if
1112
+ * a last child exists; otherwise returns `false`.
1113
+ *
1114
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1115
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1116
+ * the caller's internal reference.
1117
+ *
1118
+ * @throws Error if the call fails (the message names the reason); the full log is in
1119
+ * {@link Xml.lastErrorText}.
1120
+ */
1121
+ lastChild2(): void
1122
+
1123
+ /**
1124
+ * Parses the XML text in `xmlData` and replaces the calling object's current XML tree content
1125
+ * with the loaded document root. Returns `true` if parsing succeeds.
1126
+ *
1127
+ * **Replacement operation:** A successful load replaces the current document/tree state
1128
+ * represented by this object; it does not append the loaded XML beneath the current element.
1129
+ *
1130
+ * @throws Error if the call fails (the message names the reason); the full log is in
1131
+ * {@link Xml.lastErrorText}.
1132
+ */
1133
+ loadXml(xmlData: string): void
1134
+
1135
+ /**
1136
+ * Parses the XML text in `xmlData` and replaces the current XML tree, like `LoadXml`. The
1137
+ * `autoTrim` argument additionally controls whether leading and trailing whitespace is removed
1138
+ * from each leaf element's text content while loading.
1139
+ *
1140
+ * **Whitespace significance:** Set `autoTrim` to `false` when leading or trailing text whitespace
1141
+ * is significant to the application.
1142
+ *
1143
+ * @throws Error if the call fails (the message names the reason); the full log is in
1144
+ * {@link Xml.lastErrorText}.
1145
+ */
1146
+ loadXml2(xmlData: string, autoTrim: boolean): void
1147
+
1148
+ /**
1149
+ * Reads and parses an XML document from `fileName`, replacing the calling object's current XML
1150
+ * tree with the loaded document root. Returns `true` on success.
1151
+ *
1152
+ * The file's XML declaration and byte encoding are used as part of normal XML parsing.
1153
+ *
1154
+ * @throws Error if the call fails (the message names the reason); the full log is in
1155
+ * {@link Xml.lastErrorText}.
1156
+ */
1157
+ loadXmlFile(fileName: string): void
1158
+
1159
+ /**
1160
+ * Reads and parses an XML document from `fileName`, replacing the current XML tree. The
1161
+ * `autoTrim` argument controls whether leading and trailing whitespace is removed from each leaf
1162
+ * element's text content.
1163
+ *
1164
+ * **Whitespace significance:** Set `autoTrim` to `false` when leading or trailing text whitespace
1165
+ * must be preserved exactly.
1166
+ *
1167
+ * @throws Error if the call fails (the message names the reason); the full log is in
1168
+ * {@link Xml.lastErrorText}.
1169
+ */
1170
+ loadXmlFile2(fileName: string, autoTrim: boolean): void
1171
+
1172
+ /**
1173
+ * Creates and returns a new child at `tagPath` with the specified text `content`. A new child is
1174
+ * created even when a child with the same tag already exists.
1175
+ *
1176
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1177
+ * `tagA|tagB|tagC`. It is not XPath. Intermediate elements in a multi-part path are created as
1178
+ * needed. Use `FindOrAddNewChild` when duplicate final children should be avoided.
1179
+ *
1180
+ * @throws Error if the call fails (the message names the reason); the full log is in
1181
+ * {@link Xml.lastErrorText}.
1182
+ */
1183
+ newChild(tagPath: string, content: string): Xml
1184
+
1185
+ /**
1186
+ * Creates a new child at `tagPath` with the specified text `content`, but does not return a
1187
+ * separate `Xml` object for the new element.
1188
+ *
1189
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1190
+ * `tagA|tagB|tagC`. It is not XPath. Intermediate elements in a multi-part path are created as
1191
+ * needed.
1192
+ */
1193
+ newChild2(tagPath: string, content: string): void
1194
+
1195
+ /**
1196
+ * Creates a new direct child with the specified `tag` and `content`, inserts it immediately after
1197
+ * the child at zero-based `index`, and returns the new child element.
1198
+ *
1199
+ * @throws Error if the call fails (the message names the reason); the full log is in
1200
+ * {@link Xml.lastErrorText}.
1201
+ */
1202
+ newChildAfter(index: number, tag: string, content: string): Xml
1203
+
1204
+ /**
1205
+ * Creates a new direct child with the specified `tag` and `content`, inserts it immediately
1206
+ * before the child at zero-based `index`, and returns the new child element.
1207
+ *
1208
+ * @throws Error if the call fails (the message names the reason); the full log is in
1209
+ * {@link Xml.lastErrorText}.
1210
+ */
1211
+ newChildBefore(index: number, tag: string, content: string): Xml
1212
+
1213
+ /**
1214
+ * Creates a new child at `tagPath` whose content is the decimal representation of `value`. No
1215
+ * separate child object is returned.
1216
+ *
1217
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1218
+ * `tagA|tagB|tagC`. It is not XPath. Intermediate elements in a multi-part path are created as
1219
+ * needed.
1220
+ */
1221
+ newChildInt2(tagPath: string, value: number): void
1222
+
1223
+ /**
1224
+ * Returns an `Xml` object referencing the current element's next sibling, or no object when there
1225
+ * is no next sibling.
1226
+ *
1227
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1228
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1229
+ * the caller's internal reference.
1230
+ *
1231
+ * @throws Error if the call fails (the message names the reason); the full log is in
1232
+ * {@link Xml.lastErrorText}.
1233
+ */
1234
+ nextSibling(): Xml
1235
+
1236
+ /**
1237
+ * Moves the calling `Xml` object's internal reference to its next sibling. Returns `true` if one
1238
+ * exists; otherwise returns `false`.
1239
+ *
1240
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1241
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1242
+ * the caller's internal reference.
1243
+ */
1244
+ nextSibling2(): boolean
1245
+
1246
+ /**
1247
+ * Returns the number of direct children whose tag exactly equals `tag`. Descendants below those
1248
+ * children are not included.
1249
+ */
1250
+ numChildrenHavingTag(tag: string): number
1251
+
1252
+ /**
1253
+ * Returns an `Xml` object referencing the current element's previous sibling, or no object when
1254
+ * there is no previous sibling.
1255
+ *
1256
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1257
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1258
+ * the caller's internal reference.
1259
+ *
1260
+ * @throws Error if the call fails (the message names the reason); the full log is in
1261
+ * {@link Xml.lastErrorText}.
1262
+ */
1263
+ previousSibling(): Xml
1264
+
1265
+ /**
1266
+ * Moves the calling `Xml` object's internal reference to its previous sibling. Returns `true` if
1267
+ * one exists; otherwise returns `false`.
1268
+ *
1269
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1270
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1271
+ * the caller's internal reference.
1272
+ *
1273
+ * @throws Error if the call fails (the message names the reason); the full log is in
1274
+ * {@link Xml.lastErrorText}.
1275
+ */
1276
+ previousSibling2(): void
1277
+
1278
+ /**
1279
+ * Removes every attribute from the calling element. Returns `true` on success.
1280
+ *
1281
+ * @throws Error if the call fails (the message names the reason); the full log is in
1282
+ * {@link Xml.lastErrorText}.
1283
+ */
1284
+ removeAllAttributes(): void
1285
+
1286
+ /**
1287
+ * Removes all direct child elements and their subtrees from the calling element. The calling
1288
+ * element's own tag, attributes, and text content are retained.
1289
+ */
1290
+ removeAllChildren(): void
1291
+
1292
+ /**
1293
+ * Removes the attribute named `name` from the calling element. Returns `true` when the operation
1294
+ * succeeds.
1295
+ *
1296
+ * @throws Error if the call fails (the message names the reason); the full log is in
1297
+ * {@link Xml.lastErrorText}.
1298
+ */
1299
+ removeAttribute(name: string): void
1300
+
1301
+ /**
1302
+ * Removes all child elements selected by `tagPath` beneath the calling element.
1303
+ *
1304
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1305
+ * `tagA|tagB|tagC`. It is not XPath.
1306
+ *
1307
+ * **All matches:** This method removes matching children rather than returning a removed subtree.
1308
+ * Use an `ExtractChild...` method when the removed element must be retained.
1309
+ */
1310
+ removeChild(tagPath: string): void
1311
+
1312
+ /**
1313
+ * Removes the direct child at zero-based `index`, including that child's entire subtree.
1314
+ */
1315
+ removeChildByIndex(index: number): void
1316
+
1317
+ /**
1318
+ * Removes all direct children whose text content exactly equals `content`, including each removed
1319
+ * child's subtree.
1320
+ */
1321
+ removeChildWithContent(content: string): void
1322
+
1323
+ /**
1324
+ * Detaches the calling element and its entire subtree from its parent. The detached element
1325
+ * becomes the root of its own independent XML tree.
1326
+ *
1327
+ * **Object remains usable:** This method removes the subtree from its former document but keeps
1328
+ * the calling `Xml` object referencing the detached subtree.
1329
+ */
1330
+ removeFromTree(): void
1331
+
1332
+ /**
1333
+ * Decodes the binary content stored in this element and writes the resulting bytes to `filename`.
1334
+ * Set `unzipFlag` and `decryptFlag` to reverse the transformations originally applied, and supply
1335
+ * the corresponding `password` when decrypting.
1336
+ *
1337
+ * Returns `true` on success and `false` on failure.
1338
+ *
1339
+ * @throws Error if the call fails (the message names the reason); the full log is in
1340
+ * {@link Xml.lastErrorText}.
1341
+ */
1342
+ saveBinaryContent(filename: string, unzipFlag: boolean, decryptFlag: boolean, password: string): void
1343
+
1344
+ /**
1345
+ * Serializes the XML tree or subtree rooted at the current element and writes it to `fileName`.
1346
+ *
1347
+ * Document/output properties such as `Encoding`, `EmitBom`, `EmitXmlDecl`, and `EmitCompact`
1348
+ * affect the generated output as applicable.
1349
+ *
1350
+ * Returns `true` on success and `false` on failure.
1351
+ *
1352
+ * @throws Error if the call fails (the message names the reason); the full log is in
1353
+ * {@link Xml.lastErrorText}.
1354
+ */
1355
+ saveXml(fileName: string): void
1356
+
1357
+ /**
1358
+ * Returns the first element whose text content matches `contentPattern`, regardless of tag name.
1359
+ *
1360
+ * The search is breadth-first within the subtree rooted at the caller. The `afterPtr` argument
1361
+ * identifies the element after which matching should begin, allowing repeated calls to continue
1362
+ * an iteration. To begin at the first candidate, use _NULL_ where the language binding permits
1363
+ * it; ActiveX callers should pass a reference to the caller's element instead.
1364
+ *
1365
+ * Wildcard patterns are case-sensitive and may contain `*`, where each asterisk matches zero or
1366
+ * more characters.
1367
+ *
1368
+ * **Iteration:** Pass the element returned by one call as `afterPtr` on the next call to continue
1369
+ * to the next match. Continue until no further element is returned.
1370
+ *
1371
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1372
+ * Chilkat bindings; here it comes last so that it can be left out.
1373
+ *
1374
+ * @throws Error if the call fails (the message names the reason); the full log is in
1375
+ * {@link Xml.lastErrorText}.
1376
+ */
1377
+ searchAllForContent(contentPattern: string, after?: Xml): Xml
1378
+
1379
+ /**
1380
+ * Performs the same breadth-first content search as `SearchAllForContent`, but moves the calling
1381
+ * `Xml` object's internal reference to the matching element instead of returning a separate
1382
+ * element object.
1383
+ *
1384
+ * The search is breadth-first within the subtree rooted at the caller. The `afterPtr` argument
1385
+ * identifies the element after which matching should begin, allowing repeated calls to continue
1386
+ * an iteration. To begin at the first candidate, use _NULL_ where the language binding permits
1387
+ * it; ActiveX callers should pass a reference to the caller's element instead.
1388
+ *
1389
+ * Wildcard patterns are case-sensitive and may contain `*`, where each asterisk matches zero or
1390
+ * more characters.
1391
+ *
1392
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1393
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1394
+ * the caller's internal reference.
1395
+ *
1396
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1397
+ * Chilkat bindings; here it comes last so that it can be left out.
1398
+ *
1399
+ * @throws Error if the call fails (the message names the reason); the full log is in
1400
+ * {@link Xml.lastErrorText}.
1401
+ */
1402
+ searchAllForContent2(contentPattern: string, after?: Xml): void
1403
+
1404
+ /**
1405
+ * Returns the first element whose tag equals `tag`, that has an attribute named `attr`, and whose
1406
+ * attribute value matches `valuePattern`.
1407
+ *
1408
+ * The search is breadth-first within the subtree rooted at the caller. The `afterPtr` argument
1409
+ * identifies the element after which matching should begin, allowing repeated calls to continue
1410
+ * an iteration. To begin at the first candidate, use _NULL_ where the language binding permits
1411
+ * it; ActiveX callers should pass a reference to the caller's element instead.
1412
+ *
1413
+ * Wildcard patterns are case-sensitive and may contain `*`, where each asterisk matches zero or
1414
+ * more characters.
1415
+ *
1416
+ * **Iteration:** Pass the previous match as `afterPtr` to continue searching after that element.
1417
+ *
1418
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1419
+ * Chilkat bindings; here it comes last so that it can be left out.
1420
+ *
1421
+ * @throws Error if the call fails (the message names the reason); the full log is in
1422
+ * {@link Xml.lastErrorText}.
1423
+ */
1424
+ searchForAttribute(tag: string, attr: string, valuePattern: string, after?: Xml): Xml
1425
+
1426
+ /**
1427
+ * Performs the same breadth-first tag/attribute search as `SearchForAttribute`, but moves the
1428
+ * calling `Xml` object's internal reference to the matching element instead of returning a
1429
+ * separate object.
1430
+ *
1431
+ * The search is breadth-first within the subtree rooted at the caller. The `afterPtr` argument
1432
+ * identifies the element after which matching should begin, allowing repeated calls to continue
1433
+ * an iteration. To begin at the first candidate, use _NULL_ where the language binding permits
1434
+ * it; ActiveX callers should pass a reference to the caller's element instead.
1435
+ *
1436
+ * Wildcard patterns are case-sensitive and may contain `*`, where each asterisk matches zero or
1437
+ * more characters.
1438
+ *
1439
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1440
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1441
+ * the caller's internal reference.
1442
+ *
1443
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1444
+ * Chilkat bindings; here it comes last so that it can be left out.
1445
+ *
1446
+ * @throws Error if the call fails (the message names the reason); the full log is in
1447
+ * {@link Xml.lastErrorText}.
1448
+ */
1449
+ searchForAttribute2(tag: string, attr: string, valuePattern: string, after?: Xml): void
1450
+
1451
+ /**
1452
+ * Returns the first element whose tag equals `tag` and whose text content matches
1453
+ * `contentPattern`.
1454
+ *
1455
+ * The search is breadth-first within the subtree rooted at the caller. The `afterPtr` argument
1456
+ * identifies the element after which matching should begin, allowing repeated calls to continue
1457
+ * an iteration. To begin at the first candidate, use _NULL_ where the language binding permits
1458
+ * it; ActiveX callers should pass a reference to the caller's element instead.
1459
+ *
1460
+ * Wildcard patterns are case-sensitive and may contain `*`, where each asterisk matches zero or
1461
+ * more characters.
1462
+ *
1463
+ * **Iteration:** Pass the previous match as `afterPtr` to continue searching after that element.
1464
+ *
1465
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1466
+ * Chilkat bindings; here it comes last so that it can be left out.
1467
+ *
1468
+ * @throws Error if the call fails (the message names the reason); the full log is in
1469
+ * {@link Xml.lastErrorText}.
1470
+ */
1471
+ searchForContent(tag: string, contentPattern: string, after?: Xml): Xml
1472
+
1473
+ /**
1474
+ * Performs the same breadth-first tag/content search as `SearchForContent`, but moves the calling
1475
+ * `Xml` object's internal reference to the matching element.
1476
+ *
1477
+ * The search is breadth-first within the subtree rooted at the caller. The `afterPtr` argument
1478
+ * identifies the element after which matching should begin, allowing repeated calls to continue
1479
+ * an iteration. To begin at the first candidate, use _NULL_ where the language binding permits
1480
+ * it; ActiveX callers should pass a reference to the caller's element instead.
1481
+ *
1482
+ * Wildcard patterns are case-sensitive and may contain `*`, where each asterisk matches zero or
1483
+ * more characters.
1484
+ *
1485
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1486
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1487
+ * the caller's internal reference.
1488
+ *
1489
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1490
+ * Chilkat bindings; here it comes last so that it can be left out.
1491
+ *
1492
+ * @throws Error if the call fails (the message names the reason); the full log is in
1493
+ * {@link Xml.lastErrorText}.
1494
+ */
1495
+ searchForContent2(tag: string, contentPattern: string, after?: Xml): void
1496
+
1497
+ /**
1498
+ * Returns the first element whose tag exactly equals `tag`.
1499
+ *
1500
+ * The search is breadth-first within the subtree rooted at the caller. `afterPtr` identifies the
1501
+ * element after which searching begins. To begin at the first candidate, use _NULL_ where the
1502
+ * language binding permits it; ActiveX callers should pass a reference to the caller's element.
1503
+ *
1504
+ * **Iteration:** Pass the previous match as `afterPtr` to find the next matching tag. Continue
1505
+ * until no further element is returned.
1506
+ *
1507
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1508
+ * Chilkat bindings; here it comes last so that it can be left out.
1509
+ *
1510
+ * @throws Error if the call fails (the message names the reason); the full log is in
1511
+ * {@link Xml.lastErrorText}.
1512
+ */
1513
+ searchForTag(tag: string, after?: Xml): Xml
1514
+
1515
+ /**
1516
+ * Performs the same breadth-first tag search as `SearchForTag`, but moves the calling `Xml`
1517
+ * object's internal reference to the matching element instead of returning a separate object.
1518
+ *
1519
+ * Use `afterPtr` in the same way as with `SearchForTag` to begin or continue the search.
1520
+ *
1521
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1522
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1523
+ * the caller's internal reference.
1524
+ *
1525
+ * `after` may be omitted (Chilkat's null pointer). It is the first argument in other
1526
+ * Chilkat bindings; here it comes last so that it can be left out.
1527
+ *
1528
+ * @throws Error if the call fails (the message names the reason); the full log is in
1529
+ * {@link Xml.lastErrorText}.
1530
+ */
1531
+ searchForTag2(tag: string, after?: Xml): void
1532
+
1533
+ /**
1534
+ * Reads the bytes from `filename` and stores them as this element's binary content, with optional
1535
+ * ZIP compression and optional password-based encryption. The resulting stored data is
1536
+ * represented as Base64 when XML text is generated.
1537
+ *
1538
+ * Returns `true` on success and `false` on failure.
1539
+ *
1540
+ * @throws Error if the call fails (the message names the reason); the full log is in
1541
+ * {@link Xml.lastErrorText}.
1542
+ */
1543
+ setBinaryContentFromFile(filename: string, zipFlag: boolean, encryptFlag: boolean, password: string): void
1544
+
1545
+ /**
1546
+ * Sorts the calling element's direct children by the string value of attribute `attrName`. Set
1547
+ * `ascending` to `true` for ascending order or `false` for descending order.
1548
+ *
1549
+ * `SortCaseInsensitive` controls case sensitivity for string sorting.
1550
+ */
1551
+ sortByAttribute(attrName: string, ascending: boolean): void
1552
+
1553
+ /**
1554
+ * Sorts the calling element's direct children numerically by the value of attribute `attrName`,
1555
+ * interpreting each sort value as an integer rather than comparing the text lexicographically.
1556
+ *
1557
+ * Set `ascending` to `true` for ascending order or `false` for descending order.
1558
+ */
1559
+ sortByAttributeInt(attrName: string, ascending: boolean): void
1560
+
1561
+ /**
1562
+ * Sorts the calling element's direct children by their text content. Set `ascending` to `true`
1563
+ * for ascending order or `false` for descending order.
1564
+ *
1565
+ * `SortCaseInsensitive` controls case sensitivity for the string comparison.
1566
+ */
1567
+ sortByContent(ascending: boolean): void
1568
+
1569
+ /**
1570
+ * Sorts the calling element's direct children by tag name. Set `ascending` to `true` for
1571
+ * ascending order or `false` for descending order.
1572
+ *
1573
+ * `SortCaseInsensitive` controls case sensitivity for the tag-name comparison.
1574
+ */
1575
+ sortByTag(ascending: boolean): void
1576
+
1577
+ /**
1578
+ * Treats each direct child as a record and sorts those records by the value of attribute
1579
+ * `attrName` on the record's child identified by `sortTag`.
1580
+ *
1581
+ * Set `ascending` to `true` for ascending order or `false` for descending order. String
1582
+ * comparisons honor `SortCaseInsensitive`.
1583
+ */
1584
+ sortRecordsByAttribute(sortTag: string, attrName: string, ascending: boolean): void
1585
+
1586
+ /**
1587
+ * Treats each direct child as a record and sorts those records by the text content of the
1588
+ * record's child named `sortTag`.
1589
+ *
1590
+ * Set `ascending` to `true` for ascending order or `false` for descending order. String
1591
+ * comparisons honor `SortCaseInsensitive`.
1592
+ */
1593
+ sortRecordsByContent(sortTag: string, ascending: boolean): void
1594
+
1595
+ /**
1596
+ * Treats each direct child as a record and sorts those records numerically by the integer content
1597
+ * of the record's child named `sortTag`.
1598
+ *
1599
+ * Numeric comparison is used instead of lexicographic string comparison. Set `ascending` to
1600
+ * `true` for ascending order or `false` for descending order.
1601
+ */
1602
+ sortRecordsByContentInt(sortTag: string, ascending: boolean): void
1603
+
1604
+ /**
1605
+ * Swaps the calling element's tag, text content, and attributes with those of `node`.
1606
+ *
1607
+ * Returns `true` on success and `false` on failure.
1608
+ *
1609
+ * **Children are not swapped:** Use `SwapTree` when child subtrees should also be exchanged.
1610
+ *
1611
+ * @throws Error if the call fails (the message names the reason); the full log is in
1612
+ * {@link Xml.lastErrorText}.
1613
+ */
1614
+ swapNode(node: Xml): void
1615
+
1616
+ /**
1617
+ * Swaps the calling element's complete tree state with `tree`, including tag, text content,
1618
+ * attributes, and children.
1619
+ *
1620
+ * Returns `true` on success and `false` on failure.
1621
+ *
1622
+ * @throws Error if the call fails (the message names the reason); the full log is in
1623
+ * {@link Xml.lastErrorText}.
1624
+ */
1625
+ swapTree(tree: Xml): void
1626
+
1627
+ /**
1628
+ * Searches the subtree rooted at the calling element for the first element whose tag equals
1629
+ * `tagName` and returns that element's text content.
1630
+ *
1631
+ * **Recursive search:** Unlike direct-child getters, this search is not limited to the caller's
1632
+ * immediate children.
1633
+ *
1634
+ * @throws Error if the call fails (the message names the reason); the full log is in
1635
+ * {@link Xml.lastErrorText}.
1636
+ */
1637
+ tagContent(tagName: string): string
1638
+
1639
+ /**
1640
+ * Returns `true` if the calling element's complete tag name, including any namespace prefix,
1641
+ * exactly equals `tag`; otherwise returns `false`.
1642
+ */
1643
+ tagEquals(tag: string): boolean
1644
+
1645
+ /**
1646
+ * Reverses `ZipContent`: decodes and decompresses the calling element's compressed content and
1647
+ * replaces the stored Base64-compressed representation with the original content.
1648
+ *
1649
+ * Returns `true` on success and `false` on failure.
1650
+ *
1651
+ * @throws Error if the call fails (the message names the reason); the full log is in
1652
+ * {@link Xml.lastErrorText}.
1653
+ */
1654
+ unzipContent(): void
1655
+
1656
+ /**
1657
+ * Reverses `ZipTree`: decompresses the stored representation and reconstructs the calling
1658
+ * element's previously compressed subtree.
1659
+ *
1660
+ * The element's tag and attributes, which are not replaced by `ZipTree`, remain associated with
1661
+ * the restored tree.
1662
+ *
1663
+ * Returns `true` on success and `false` on failure.
1664
+ *
1665
+ * @throws Error if the call fails (the message names the reason); the full log is in
1666
+ * {@link Xml.lastErrorText}.
1667
+ */
1668
+ unzipTree(): void
1669
+
1670
+ /**
1671
+ * Sets attribute `attrName` to `attrValue`. If the attribute already exists its value is
1672
+ * replaced; otherwise the attribute is added.
1673
+ *
1674
+ * Returns `true` on success and `false` on failure.
1675
+ *
1676
+ * @throws Error if the call fails (the message names the reason); the full log is in
1677
+ * {@link Xml.lastErrorText}.
1678
+ */
1679
+ updateAttribute(attrName: string, attrValue: string): void
1680
+
1681
+ /**
1682
+ * Sets attribute `attrName` to the decimal representation of integer `value`. Use
1683
+ * `UpdateAttribute` for string values.
1684
+ *
1685
+ * Returns `true` on success and `false` on failure.
1686
+ *
1687
+ * @throws Error if the call fails (the message names the reason); the full log is in
1688
+ * {@link Xml.lastErrorText}.
1689
+ */
1690
+ updateAttributeInt(attrName: string, value: number): void
1691
+
1692
+ /**
1693
+ * Sets the text content of the child selected by `tagPath` to `value`. Missing elements along the
1694
+ * path are automatically created as needed.
1695
+ *
1696
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1697
+ * `tagA|tagB|tagC`. It is not XPath.
1698
+ */
1699
+ updateChildContent(tagPath: string, value: string): void
1700
+
1701
+ /**
1702
+ * Sets the content of the child selected by `tagPath` to the decimal representation of integer
1703
+ * `value`.
1704
+ *
1705
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1706
+ * `tagA|tagB|tagC`. It is not XPath.
1707
+ */
1708
+ updateChildContentInt(tagPath: string, value: number): void
1709
+
1710
+ /**
1711
+ * ZIP-compresses this element's text content and replaces the original content with
1712
+ * Base64-encoded compressed data.
1713
+ *
1714
+ * Returns `true` on success and `false` on failure.
1715
+ *
1716
+ * **Reversible transformation:** Call `UnzipContent` to restore the original content.
1717
+ *
1718
+ * @throws Error if the call fails (the message names the reason); the full log is in
1719
+ * {@link Xml.lastErrorText}.
1720
+ */
1721
+ zipContent(): void
1722
+
1723
+ /**
1724
+ * ZIP-compresses the calling element's content together with its entire child subtree and
1725
+ * replaces that structure with Base64-encoded compressed data.
1726
+ *
1727
+ * The calling element's tag and attributes are not changed. Call `UnzipTree` to reconstruct the
1728
+ * compressed subtree.
1729
+ *
1730
+ * Returns `true` on success and `false` on failure.
1731
+ *
1732
+ * @throws Error if the call fails (the message names the reason); the full log is in
1733
+ * {@link Xml.lastErrorText}.
1734
+ */
1735
+ zipTree(): void
1736
+
1737
+ /**
1738
+ * Parses XML from the current contents of `sb` and replaces the calling object's current XML tree
1739
+ * with the loaded document.
1740
+ *
1741
+ * If `autoTrim` is `true`, leading and trailing whitespace is removed from each leaf element's
1742
+ * text content while loading.
1743
+ *
1744
+ * Returns `true` on success and `false` on failure.
1745
+ *
1746
+ * @throws Error if the call fails (the message names the reason); the full log is in
1747
+ * {@link Xml.lastErrorText}.
1748
+ */
1749
+ loadSb(sb: StringBuilder, autoTrim: boolean): void
1750
+
1751
+ /**
1752
+ * Serializes the XML tree or subtree rooted at the current element and appends the resulting XML
1753
+ * text to `sb`.
1754
+ *
1755
+ * The existing contents of `sb` are preserved. Output properties such as `EmitCompact` and
1756
+ * `EmitXmlDecl` apply as appropriate.
1757
+ *
1758
+ * Returns `true` on success and `false` on failure.
1759
+ *
1760
+ * @throws Error if the call fails (the message names the reason); the full log is in
1761
+ * {@link Xml.lastErrorText}.
1762
+ */
1763
+ getXmlSb(sb: StringBuilder): void
1764
+
1765
+ /**
1766
+ * Returns the number of direct children of the element selected by `tagPath`. Returns `-1` if the
1767
+ * path does not identify an existing element.
1768
+ *
1769
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1770
+ * `tagA|tagB|tagC`. It is not XPath.
1771
+ */
1772
+ numChildrenAt(tagPath: string): number
1773
+
1774
+ /**
1775
+ * Sets the text content of the element selected by `tagPath` to `value`.
1776
+ *
1777
+ * If `autoCreate` is `true`, missing elements along the path are created as needed. If it is
1778
+ * `false`, the update requires the target path to already exist.
1779
+ *
1780
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1781
+ * `tagA|tagB|tagC`. It is not XPath.
1782
+ *
1783
+ * @throws Error if the call fails (the message names the reason); the full log is in
1784
+ * {@link Xml.lastErrorText}.
1785
+ */
1786
+ updateAt(tagPath: string, autoCreate: boolean, value: string): void
1787
+
1788
+ /**
1789
+ * Sets attribute `attrName` to `attrValue` on the element selected by `tagPath`. The attribute is
1790
+ * added when it does not already exist.
1791
+ *
1792
+ * If `autoCreate` is `true`, missing elements along the path are created as needed. If it is
1793
+ * `false`, the target path must already exist.
1794
+ *
1795
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1796
+ * `tagA|tagB|tagC`. It is not XPath.
1797
+ *
1798
+ * @throws Error if the call fails (the message names the reason); the full log is in
1799
+ * {@link Xml.lastErrorText}.
1800
+ */
1801
+ updateAttrAt(tagPath: string, autoCreate: boolean, attrName: string, attrValue: string): void
1802
+
1803
+ /**
1804
+ * Finds the element selected by `tagPath` and appends that element's text content to `sb`.
1805
+ *
1806
+ * The existing contents of the `StringBuilder` are preserved.
1807
+ *
1808
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1809
+ * `tagA|tagB|tagC`. It is not XPath.
1810
+ *
1811
+ * Returns `true` on success and `false` on failure.
1812
+ *
1813
+ * @throws Error if the call fails (the message names the reason); the full log is in
1814
+ * {@link Xml.lastErrorText}.
1815
+ */
1816
+ getChildContentSb(tagPath: string, sb: StringBuilder): void
1817
+
1818
+ /**
1819
+ * Returns the zero-based child index of the element selected by `tagPath`. Returns `-1` when no
1820
+ * matching element is found at that path.
1821
+ *
1822
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1823
+ * `tagA|tagB|tagC`. It is not XPath.
1824
+ *
1825
+ * **Index meaning:** The returned index is the element's position among its parent's direct
1826
+ * children, which is the index accepted by methods such as `GetChild`, `RemoveChildByIndex`, and
1827
+ * the insertion methods.
1828
+ */
1829
+ tagIndex(tagPath: string): number
1830
+
1831
+ /**
1832
+ * Returns `true` if this element's namespace-prefix portion exactly equals `ns`; otherwise
1833
+ * returns `false`.
1834
+ *
1835
+ * For example, the namespace prefix of `soapenv:Body` is `soapenv`.
1836
+ *
1837
+ * **Prefix comparison:** This compares the lexical prefix, not the namespace URI bound to that
1838
+ * prefix.
1839
+ */
1840
+ tagNsEquals(ns: string): boolean
1841
+
1842
+ /**
1843
+ * Returns `true` if this element's unprefixed tag exactly equals `unprefixedTag`; otherwise
1844
+ * returns `false`.
1845
+ *
1846
+ * For example, the unprefixed tag of `soapenv:Body` is `Body`.
1847
+ */
1848
+ tagUnpEquals(unprefixedTag: string): boolean
1849
+
1850
+ /**
1851
+ * Returns the value of attribute `attrName` on the descendant element selected by `tagPath`.
1852
+ *
1853
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1854
+ * `tagA|tagB|tagC`. It is not XPath.
1855
+ *
1856
+ * @throws Error if the call fails (the message names the reason); the full log is in
1857
+ * {@link Xml.lastErrorText}.
1858
+ */
1859
+ getChildAttrValue(tagPath: string, attrName: string): string
1860
+
1861
+ /**
1862
+ * Removes XML stylesheet processing instructions whose attribute named `attrName` has the value
1863
+ * `attrValue`.
1864
+ *
1865
+ * Returns the number of matching stylesheet declarations removed, or `-1` if an error occurs.
1866
+ */
1867
+ removeStyleSheet(attrName: string, attrValue: string): number
1868
+
1869
+ /**
1870
+ * Recursively traverses the subtree rooted at the calling element and removes every occurrence of
1871
+ * the attribute named `attrName`.
1872
+ *
1873
+ * Returns the number of attributes removed.
1874
+ */
1875
+ pruneAttribute(attrName: string): number
1876
+
1877
+ /**
1878
+ * Recursively traverses the subtree rooted at the calling element and removes every element whose
1879
+ * tag equals `tag`. Each removed element's entire descendant subtree is removed with it.
1880
+ *
1881
+ * Returns the number of matching tag occurrences removed.
1882
+ *
1883
+ * **Subtree pruning:** When a matching parent is removed, its descendants disappear as part of
1884
+ * that subtree; this method is intended for structural cleanup rather than text-only removal.
1885
+ */
1886
+ pruneTag(tag: string): number
1887
+
1888
+ /**
1889
+ * Recursively normalizes the XML subtree rooted at the calling element according to the
1890
+ * comma-separated keywords in `directives`.
1891
+ *
1892
+ * Supported directives are:
1893
+ *
1894
+ * - `AttrTrimEnds` - remove leading and trailing whitespace from attribute values.
1895
+ *
1896
+ * - `AttrTrimInside` - replace tabs, CR, and LF with spaces and collapse repeated spaces inside
1897
+ * attribute values.
1898
+ *
1899
+ * - `ContentTrimEnds` - remove leading and trailing whitespace from element content.
1900
+ *
1901
+ * - `ContentTrimInside` - normalize internal tabs/line breaks/spaces in element content.
1902
+ *
1903
+ * - `LowercaseAttrs` - convert attribute names to lowercase.
1904
+ *
1905
+ * - `LowercaseTags` - convert tag names to lowercase.
1906
+ *
1907
+ * - `RemoveCtrl` - remove US-ASCII control characters with values 0-31 except TAB, CR, and LF.
1908
+ *
1909
+ * **Destructive normalization:** Scrubbing modifies the tree. Use these options only when the
1910
+ * corresponding whitespace, letter case, or control characters are not semantically significant
1911
+ * to the application.
1912
+ */
1913
+ scrub(directives: string): void
1914
+
1915
+ /**
1916
+ * Parses XML from the bytes contained in `bd` and replaces the calling object's current XML tree
1917
+ * with the loaded document.
1918
+ *
1919
+ * If `autoTrim` is `true`, leading and trailing whitespace is removed from each leaf element's
1920
+ * text content during loading.
1921
+ *
1922
+ * Returns `true` on success and `false` on failure.
1923
+ *
1924
+ * @throws Error if the call fails (the message names the reason); the full log is in
1925
+ * {@link Xml.lastErrorText}.
1926
+ */
1927
+ loadBd(bd: BinData, autoTrim: boolean): void
1928
+
1929
+ /**
1930
+ * Serializes the XML tree or subtree rooted at the current element and appends the encoded XML
1931
+ * bytes to `bd`.
1932
+ *
1933
+ * The existing contents of the `BinData` object are preserved. The XML output encoding is
1934
+ * governed by the XML document's output settings, including `Encoding`.
1935
+ *
1936
+ * Returns `true` on success and `false` on failure.
1937
+ *
1938
+ * @throws Error if the call fails (the message names the reason); the full log is in
1939
+ * {@link Xml.lastErrorText}.
1940
+ */
1941
+ getXmlBd(bd: BinData): void
1942
+
1943
+ /**
1944
+ * Moves the calling `Xml` object to the next element in a depth-first traversal of the tree and
1945
+ * updates `sbState` with the traversal state.
1946
+ *
1947
+ * Pass an empty `StringBuilder` when beginning a traversal, then reuse the same `sbState` for
1948
+ * each subsequent call.
1949
+ *
1950
+ * **Why the name ends in 2:** This method changes the caller's internal element reference. There
1951
+ * is no separate `NextInTraversal` method that returns another `Xml` object.
1952
+ */
1953
+ nextInTraversal2(sbState: StringBuilder): boolean
1954
+
1955
+ /**
1956
+ * Stores the bytes in `data` as binary content on this element, with optional ZIP compression and
1957
+ * optional password-based AES encryption. The stored binary representation is emitted as Base64
1958
+ * text when XML is serialized.
1959
+ *
1960
+ * If `zipFlag` is `true`, the bytes are compressed first. If `encryptFlag` is `true`, the data is
1961
+ * encrypted using Chilkat's 128-bit Rijndael/AES format and `password`.
1962
+ *
1963
+ * Returns `true` on success and `false` on failure.
1964
+ *
1965
+ * **Round trip:** Use the corresponding binary-content retrieval methods with matching
1966
+ * decompression/decryption options to recover the original bytes.
1967
+ *
1968
+ * @throws Error if the call fails (the message names the reason); the full log is in
1969
+ * {@link Xml.lastErrorText}.
1970
+ */
1971
+ setBinaryContentBd(data: BinData, zipFlag: boolean, encryptFlag: boolean, password: string): void
1972
+
1973
+ /**
1974
+ * Moves the calling `Xml` object's internal reference to the child selected by `tagPath`. Returns
1975
+ * `true` when the child is found and the move succeeds; otherwise returns `false`.
1976
+ *
1977
+ * **Tag paths:** A tag path is Chilkat's `|`-separated child-navigation syntax, for example
1978
+ * `tagA|tagB|tagC`. It is not XPath.
1979
+ *
1980
+ * **Element-reference behavior:** Methods that return an `Xml` object return another object
1981
+ * referencing an element in the same underlying tree. Methods whose names end in `2` instead move
1982
+ * the caller's internal reference.
1983
+ *
1984
+ * @throws Error if the call fails (the message names the reason); the full log is in
1985
+ * {@link Xml.lastErrorText}.
1986
+ */
1987
+ getChildWithTag2(tagPath: string): void
1988
+ }