@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,3095 @@
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 { Cert } from './Cert.nitro'
5
+ import type { Hashtable } from './Hashtable.nitro'
6
+ import type { HttpRequest } from './HttpRequest.nitro'
7
+ import type { HttpResponse } from './HttpResponse.nitro'
8
+ import type { JsonObject } from './JsonObject.nitro'
9
+ import type { PrivateKey } from './PrivateKey.nitro'
10
+ import type { SecureString } from './SecureString.nitro'
11
+ import type { StringBuilder } from './StringBuilder.nitro'
12
+ import type { StringTable } from './StringTable.nitro'
13
+
14
+ /**
15
+ * HTTPS client for REST API calls, GET/POST/PUT/DELETE/PATCH requests, uploads, and downloads.
16
+ *
17
+ * `Http` is a comprehensive HTTP and HTTPS client class for
18
+ * applications that need to call REST APIs, download files, upload data, submit
19
+ * forms, send JSON or XML, stream large responses, manage cookies and redirects,
20
+ * authenticate with modern or legacy schemes, use TLS client certificates, work
21
+ * through proxies, and troubleshoot HTTP communication in detail.
22
+ *
23
+ * **REST and API requests**
24
+ *
25
+ * Send GET, POST, PUT, PATCH, DELETE, and custom HTTP requests with headers,
26
+ * query parameters, JSON, XML, form data, or raw request bodies.
27
+ *
28
+ * **Uploads and downloads**
29
+ *
30
+ * Download to memory, files, streams, `BinData`, or
31
+ * `StringBuilder`, and upload files, forms, multipart content,
32
+ * or application data.
33
+ *
34
+ * **Authentication**
35
+ *
36
+ * Use Basic, Digest, NTLM, Negotiate, Bearer tokens, OAuth2 access tokens,
37
+ * AWS signatures, and other service-specific authentication patterns.
38
+ *
39
+ * **TLS, proxies, and networking**
40
+ *
41
+ * Configure HTTPS, client certificates, TLS behavior, HTTP proxies, SOCKS
42
+ * proxies, proxy authentication, custom timeouts, and network interface
43
+ * preferences.
44
+ *
45
+ * **Cookies, redirects, and sessions**
46
+ *
47
+ * Manage cookies, follow redirects, preserve session state, control request
48
+ * headers, and inspect response headers and status codes.
49
+ *
50
+ * **S3-compatible storage**
51
+ *
52
+ * Use built-in helpers for Amazon S3 and S3-compatible object storage
53
+ * operations such as upload, download, delete, copy, and listing workflows.
54
+ *
55
+ * **Common pattern:**
56
+ * Configure authentication, headers, TLS, proxy, and timeout settings first;
57
+ * send the request with the method that matches the desired input/output form;
58
+ * then inspect the response status, headers, body, and `LastErrorText`
59
+ * when troubleshooting server or network behavior.
60
+ *
61
+ * For an extended overview, see
62
+ * [Http Class Overview](https://www.chilkatsoft.com/http_class_overview.asp).
63
+ *
64
+ * Each `Http` instance owns a native Chilkat object. It is released when the JavaScript object is
65
+ * garbage collected, or immediately by `dispose()`; any use after `dispose()` throws.
66
+ * Create one with `new Http()`.
67
+ *
68
+ * Methods that can take a while (network, files, compression, key generation) also have an
69
+ * `...Async` form returning a `Promise`; it runs on a native worker thread so the UI keeps
70
+ * rendering. While such a call is pending, every other call on this object throws, except
71
+ * {@link Http.abort} and assigning {@link Http.onPercentDone} / {@link Http.onProgressInfo}.
72
+ */
73
+ export interface Http extends HybridObject<{ ios: 'c++', android: 'c++' }> {
74
+ // ---- Properties ----
75
+
76
+ /**
77
+ * Provides HTML-formatted information about the last called method or property. If a method call
78
+ * fails or behaves unexpectedly, check this property for details. Note that information is
79
+ * available regardless of the method call's success.
80
+ *
81
+ * This property is read-only.
82
+ */
83
+ readonly lastErrorHtml: string
84
+
85
+ /**
86
+ * Provides plain text information about the last called method or property. If a method call
87
+ * fails or behaves unexpectedly, check this property for details. Note that information is
88
+ * available regardless of the method call's success.
89
+ *
90
+ * This property is read-only.
91
+ */
92
+ readonly lastErrorText: string
93
+
94
+ /**
95
+ * Provides XML-formatted information about the last called method or property. If a method call
96
+ * fails or behaves unexpectedly, check this property for details. Note that information is
97
+ * available regardless of the method call's success.
98
+ *
99
+ * This property is read-only.
100
+ */
101
+ readonly lastErrorXml: string
102
+
103
+ /**
104
+ * Version of the component/library, such as "10.1.0"
105
+ *
106
+ * This property is read-only.
107
+ */
108
+ readonly version: string
109
+
110
+ /**
111
+ * If set to a file path, this property logs the LastErrorText of each Chilkat method or property
112
+ * call to the specified file. This logging helps identify the context and history of Chilkat
113
+ * calls leading up to any crash or hang, aiding in debugging.
114
+ *
115
+ * Enabling the VerboseLogging property provides more detailed information.
116
+ *
117
+ * This property is mainly used for debugging rare instances where a Chilkat method call causes a
118
+ * hang or crash, which should generally not happen.
119
+ *
120
+ * Possible causes of hangs include:
121
+ *
122
+ * - A timeout property set to 0, indicating an infinite timeout.
123
+ *
124
+ * - A hang occurring within an event callback in the application code.
125
+ *
126
+ * - An internal bug in the Chilkat code causing the hang.
127
+ */
128
+ debugLogFilePath: string
129
+
130
+ /**
131
+ * If set to `true`, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may
132
+ * contain more verbose information. The default value is `false`. Verbose logging should only be
133
+ * used for debugging. The potentially large quantity of logged information may adversely affect
134
+ * peformance.
135
+ */
136
+ verboseLogging: boolean
137
+
138
+ /**
139
+ * Indicates the success or failure of the most recent method call: `true` means success, `false`
140
+ * means failure. This property remains unchanged by property setters or getters. This method is
141
+ * present to address challenges in checking for null or Nothing returns in certain programming
142
+ * languages. Note: This property does not apply to methods that return integer values or to
143
+ * boolean-returning methods where the boolean does not indicate success or failure.
144
+ */
145
+ lastMethodSuccess: boolean
146
+
147
+ /**
148
+ * When set to `true`, causes the currently running method to abort. Methods that always finish
149
+ * quickly (i.e.have no length file operations or network communications) are not affected. If no
150
+ * method is running, then this property is automatically reset to `false` when the next method is
151
+ * called. When the abort occurs, this property is reset to `false`. Both synchronous and
152
+ * asynchronous method calls can be aborted. (A synchronous method call could be aborted by
153
+ * setting this property from a separate thread.)
154
+ */
155
+ abortCurrent: boolean
156
+
157
+ /**
158
+ * This property sets the `Accept` header for all HTTP requests, except those sent by the {@link
159
+ * Http.httpReq} and {@link Http.httpSReq} methods that use headers from an `HttpRequest` object.
160
+ *
161
+ * By default, it is set to `*\/*`.
162
+ *
163
+ * Setting this property is the same as calling {@link Http.setRequestHeader} with `Accept` as the
164
+ * header field name.
165
+ *
166
+ * The **`Accept` HTTP header** is sent by the client (your application) to tell the server
167
+ * **which content types (MIME types) it can handle in the response**.
168
+ *
169
+ * For example, the following means only a JSON response is accepted:
170
+ *
171
+ * ```
172
+ * Accept: application/json
173
+ * ```
174
+ */
175
+ accept: string
176
+
177
+ /**
178
+ * If `true` then the `Accept-Encoding: gzip` is automatically added for all HTTP requests, except
179
+ * those made using the {@link Http.httpReq} and {@link Http.httpSReq} methods that use headers
180
+ * from an HttpRequest object.
181
+ *
182
+ * The default value is `true`.
183
+ *
184
+ * The **`Accept-Encoding` HTTP header** is sent by the client to tell the server **which
185
+ * compression algorithms it supports for the response body**.
186
+ *
187
+ * Example:
188
+ *
189
+ * ```
190
+ * Accept-Encoding: gzip, deflate
191
+ * ```
192
+ *
193
+ * This means the client can handle responses compressed with **gzip** or **deflate**.
194
+ *
195
+ * If this property is set to `false`, then the `Accept-Encoding` header is added, but the value
196
+ * is empty, like this:
197
+ *
198
+ * ```
199
+ * Accept-Encoding:
200
+ * ```
201
+ *
202
+ * It means the client explicitly does not accept any content codings (no compression, no
203
+ * transformations).
204
+ *
205
+ * - An **absent** `Accept-Encoding` header means the client will accept any encoding (server
206
+ * chooses, often `gzip`).
207
+ *
208
+ * - An **empty** `Accept-Encoding` header means **only the “identity” encoding** (i.e.,
209
+ * uncompressed) is acceptable.
210
+ *
211
+ * The {@link Http.setRequestHeader} method can be called with `Accept-Encoding` as the header
212
+ * field name to explicitly set the `Accept-Encoding` header. Note: **Chilkat does not accept
213
+ * Brotli** responses. Do not include `br` in the list of encodings for this header.
214
+ *
215
+ * The {@link Http.removeRequestHeader} can be called to explicit omit the `Accept-Encoding`
216
+ * header field from HTTP requests.
217
+ */
218
+ allowGzip: boolean
219
+
220
+ /**
221
+ * When set to `true` (the default), the `Host` header is automatically added to all requests. The
222
+ * domain for the `Host` header is taken from the URL passed in a method's arguments.
223
+ *
224
+ * The **`Host` HTTP header** specifies the **hostname (and optional port)** of the server the
225
+ * client is trying to reach.
226
+ *
227
+ * Example:
228
+ *
229
+ * ```
230
+ * Host: www.example.com
231
+ * ```
232
+ *
233
+ * It’s required in HTTP/1.1 so a server can distinguish between multiple sites (virtual hosts) on
234
+ * the same IP address.
235
+ */
236
+ autoAddHostHeader: boolean
237
+
238
+ /**
239
+ * The AWS Access Key to be used with the Amazon S3 methods listed below.
240
+ */
241
+ awsAccessKey: string
242
+
243
+ /**
244
+ * Specify the regional endpoint (domain) for `Amazon S3` method calls. The default is
245
+ * `s3.amazonaws.com`, but you can use any valid Amazon S3 endpoint, such as
246
+ * `s3-eu-west-1.amazonaws.com`, or endpoints from other **S3-API compatible services**.
247
+ */
248
+ awsEndpoint: string
249
+
250
+ /**
251
+ * The AWS S3 region (e.g., `us-east-1`, `us-west-2`, `eu-west-1`, `eu-central-1`) defaults to
252
+ * `us-east-1`. It is relevant only when the `AwsSignatureVersion` property is set to 4 and
253
+ * ignored when set to 2.
254
+ */
255
+ awsRegion: string
256
+
257
+ /**
258
+ * The AWS Secret Key to be used with the Amazon S3 methods listed below.
259
+ */
260
+ awsSecretKey: string
261
+
262
+ /**
263
+ * This property can be used to specify **sub-resources** to be included in the Amazon S3 methods
264
+ * listed below. For example, set the property to `acl&versionId=value` to request the acl for a
265
+ * specific version of an object.
266
+ *
267
+ * In Amazon S3, **sub-resources** are special query parameters you can append to an S3 object or
268
+ * bucket URL to access or manage **specific properties or features** beyond the main resource
269
+ * itself.
270
+ *
271
+ * Examples:
272
+ *
273
+ * - **Bucket sub-resources:** `?logging`, `?website`, `?lifecycle`, `?policy`
274
+ *
275
+ * - **Object sub-resources:** `?acl`, `?torrent`, `?restore`, `?tagging`
276
+ *
277
+ * So:
278
+ *
279
+ * - **Resource** = the bucket or object itself (e.g., `mybucket/photo.jpg`)
280
+ *
281
+ * - **Sub-resource** = a specific aspect or configuration of it, accessed with a query string
282
+ * (e.g., `mybucket?logging` or `photo.jpg?acl`).
283
+ *
284
+ * In short: **S3 sub-resources let you operate on metadata/configuration of a bucket or object,
285
+ * not the content itself.**
286
+ */
287
+ awsSubResources: string
288
+
289
+ /**
290
+ * If set to a non-zero value, this **limits the download bandwidth** to the specified maximum
291
+ * number of bytes per second. The default value is `0`.
292
+ */
293
+ bandwidthThrottleDown: number
294
+
295
+ /**
296
+ * If set to a non-zero value, this property **limits the upload bandwidth** to the specified
297
+ * maximum number of bytes per second. The default is `0`.
298
+ */
299
+ bandwidthThrottleUp: number
300
+
301
+ /**
302
+ * To enable HTTP basic authentication, set this property to `true`. The default value is `false`.
303
+ *
304
+ * Then basic authentication is enabled, Chilkat uses the {@link Http.login} and {@link
305
+ * Http.password} properties to include the `Authorization: Basic {base64}` header in all
306
+ * requests.
307
+ *
308
+ * **HTTP Basic Authentication** is a simple authentication scheme where the client sends a
309
+ * username and password encoded in **Base64** in the `Authorization` header.
310
+ *
311
+ * Example:
312
+ *
313
+ * ```
314
+ * Authorization: Basic dXNlcjpwYXNzd29yZA==
315
+ * ```
316
+ *
317
+ * Here `dXNlcjpwYXNzd29yZA==` is the Base64 of `user:password`.
318
+ */
319
+ basicAuth: boolean
320
+
321
+ /**
322
+ * A computer can have **multiple network interfaces** (e.g., Ethernet, Wi-Fi, VPN, virtual
323
+ * adapters). Each interface can have one or more **IP addresses** (IPv4 and/or IPv6).
324
+ *
325
+ * If multiple IPs exist (say, `192.168.1.10` on Wi-Fi and `10.0.0.5` on Ethernet), the
326
+ * application can bind explicitly to either one, determining which interface and address the
327
+ * socket will use for communication.
328
+ *
329
+ * This property can be set to explicitly bind the communications socket to an IP address.
330
+ *
331
+ * The default value is the empty string, which means the application does not bind to a specific
332
+ * local IP before connecting and the OS network stack automatically picks the default source IP.
333
+ */
334
+ clientIpAddress: string
335
+
336
+ /**
337
+ * This property will be set to the status of the last HTTP connection made (or failed to be made)
338
+ * by any HTTP method.
339
+ *
340
+ * Possible values are:
341
+ *
342
+ * ```
343
+ * 0 = success
344
+ *
345
+ * Normal (non-TLS) sockets:
346
+ * 1 = empty hostname
347
+ * 2 = DNS lookup failed
348
+ * 3 = DNS timeout
349
+ * 4 = Aborted by application.
350
+ * 5 = Internal failure.
351
+ * 6 = Connect Timed Out
352
+ * 7 = Connect Rejected (or failed for some other reason)
353
+ * 50 = HTTP proxy authentication failure.
354
+ * 98 = Async operation in progress.
355
+ * 99 = Product is not unlocked.
356
+ *
357
+ * SSL/TLS:
358
+ * 100 = TLS internal error.
359
+ * 101 = Failed to send client hello.
360
+ * 102 = Unexpected handshake message.
361
+ * 103 = Failed to read server hello.
362
+ * 104 = No server certificate.
363
+ * 105 = Unexpected TLS protocol version.
364
+ * 106 = Server certificate verify failed (the server certificate is expired or the cert's signature verification failed).
365
+ * 107 = Unacceptable TLS protocol version.
366
+ * 108 = App-defined server certificate requirements failure.
367
+ * 109 = Failed to read handshake messages.
368
+ * 110 = Failed to send client certificate handshake message.
369
+ * 111 = Failed to send client key exchange handshake message.
370
+ * 112 = Client certificate's private key not accessible.
371
+ * 113 = Failed to send client cert verify handshake message.
372
+ * 114 = Failed to send change cipher spec handshake message.
373
+ * 115 = Failed to send finished handshake message.
374
+ * 116 = Server's Finished message is invalid.
375
+ * 125 = Peer tried to connect using older SSL 2.0 protocol version.
376
+ * 126 = TLS Pin Set Mismatch.
377
+ * 127 = TLS 1.3 handshake error.
378
+ * ```
379
+ *
380
+ * This property is read-only.
381
+ */
382
+ readonly connectFailReason: number
383
+
384
+ /**
385
+ * Determines the maximum time, **in seconds**, to wait for an HTTP server to accept a TCP
386
+ * connection before timing out. The **default value is 30 seconds**.
387
+ *
388
+ * Note: A **TLS connection** always starts with a normal TCP connection (e.g., client connects to
389
+ * server on port 443). Once TCP is established, the client and server perform a TLS handshake:
390
+ * they exchange cryptographic messages to authenticate, agree on encryption keys, and set up a
391
+ * secure channel.
392
+ *
393
+ * The {@link Http.readTimeout} property applies to TLS handshake communications. When
394
+ * establishing a TLS connection, the `ConnectTimeout` governs the initial TCP connection,
395
+ * followed by the `ReadTimeout`.
396
+ */
397
+ connectTimeout: number
398
+
399
+ /**
400
+ * Designates a directory path for automatic cookie storage (such as `"c:/myCookieDir"` or
401
+ * `"/Users/example/myCookieDir"`) when the {@link Http.saveCookies} property is set to `true`.
402
+ * Cookies are saved in XML files, with one file per domain. Alternatively, set the value to
403
+ * `memory` to cache cookies in memory.
404
+ *
405
+ * The **default value is the empty string**, which means cookies are not saved regardless of the
406
+ * {@link Http.saveCookies} setting.
407
+ */
408
+ cookieDir: string
409
+
410
+ /**
411
+ * Sets the default freshness period (in minutes) for cached documents when the {@link
412
+ * Http.freshnessAlgorithm} property is set to 0. The default value is 10080 (1 week).
413
+ *
414
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
415
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
416
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
417
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
418
+ * {@link Http.ignoreMustRevalidate},
419
+ * {@link Http.ignoreNoCache},
420
+ * and {@link Http.lastFromCache}.
421
+ */
422
+ defaultFreshPeriod: number
423
+
424
+ /**
425
+ * Setting this property to `true` causes the HTTP component to use digest authentication. The
426
+ * default value is `false`.
427
+ *
428
+ * HTTP **Digest Authentication** is a challenge–response mechanism where the server sends a nonce
429
+ * (a unique random value) to the client. The client must hash the username, password, nonce, and
430
+ * request details (method, URI) into a digest using MD5 (or similar). The server performs the
431
+ * same calculation to verify.
432
+ *
433
+ * Unlike **Basic Auth**, the password is never sent in clear text—only the hash is
434
+ * transmitted—making it more secure against eavesdropping.
435
+ */
436
+ digestAuth: boolean
437
+
438
+ /**
439
+ * Set to `true` to enable fetching pages from cache whenever possible. **The default value is
440
+ * `false`.** Only HTTP GET requests are cached. HTTP responses containing `Set-Cookie` headers
441
+ * are never cached. A page is retrieved from the disk cache if it exists and is deemed fresh by
442
+ * the {@link Http.freshnessAlgorithm} property. If the cached page is stale, the HTTP component
443
+ * will send a revalidate request and update the cache based on the response.
444
+ *
445
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
446
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
447
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
448
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
449
+ * {@link Http.ignoreMustRevalidate},
450
+ * {@link Http.ignoreNoCache},
451
+ * and {@link Http.lastFromCache}.
452
+ */
453
+ fetchFromCache: boolean
454
+
455
+ /**
456
+ * If the {@link Http.wasRedirected} property indicates an HTTP GET was redirected, and the {@link
457
+ * Http.followRedirects} property is set to `true`, this property will hold the final redirect
458
+ * URL. This property will also contain the redirect URL for `301/302` responses, even if {@link
459
+ * Http.followRedirects} is not `true`.
460
+ *
461
+ * This property is read-only.
462
+ */
463
+ readonly finalRedirectUrl: string
464
+
465
+ /**
466
+ * When set to `true`, `301`, `302`, `303`, `307`, and `308` redirects are automatically followed.
467
+ * The default setting is `true`.
468
+ *
469
+ * To determine if a redirect occurred, check the {@link Http.wasRedirected} property. The final
470
+ * URL after redirection is available in the {@link Http.finalRedirectUrl} property.
471
+ */
472
+ followRedirects: boolean
473
+
474
+ /**
475
+ * To determine the freshness of a cached HTTP GET response, the freshness algorithm is employed.
476
+ * By default, it uses the `LM-factor` algorithm, which is activated when the {@link
477
+ * Http.freshnessAlgorithm} is set to `1`. The {@link Http.lmFactor} property, ranging from 1 to
478
+ * 100, specifies the percentage of the time since the last modification date of the HTML page
479
+ * that the page remains fresh. For instance, if the LMFactor is 50 and the page was last modified
480
+ * 10 days ago, it will expire after 5 days (50% of 10 days). This applies only to HTTP responses
481
+ * without explicit expiration information. If the FreshnessAlgorithm is set to `0`, a constant
482
+ * expiry period, defined by the {@link Http.defaultFreshPeriod} property, is applied.
483
+ *
484
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
485
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
486
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
487
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
488
+ * {@link Http.ignoreMustRevalidate},
489
+ * {@link Http.ignoreNoCache},
490
+ * and {@link Http.lastFromCache}.
491
+ */
492
+ freshnessAlgorithm: number
493
+
494
+ /**
495
+ * The interval in milliseconds between each `AbortCheck` event callback, which enables an
496
+ * application to abort certain method calls before they complete. **By default, HeartbeatMs is
497
+ * set to **`0`**, meaning no AbortCheck event callbacks will trigger.**
498
+ */
499
+ heartbeatMs: number
500
+
501
+ /**
502
+ * If an HTTP response includes the `Cache-Control: must-revalidate` header, it indicates that the
503
+ * server requires the client to revalidate the page with the server rather than serving it
504
+ * directly from the cache. However, if this property is set to `true`, the page will be served
505
+ * directly from the cache without revalidation until it expires. The defautl value of this
506
+ * property is `false`.
507
+ *
508
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
509
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
510
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
511
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
512
+ * {@link Http.ignoreMustRevalidate},
513
+ * {@link Http.ignoreNoCache},
514
+ * and {@link Http.lastFromCache}.
515
+ */
516
+ ignoreMustRevalidate: boolean
517
+
518
+ /**
519
+ * Some HTTP responses include headers indicating the page should not be cached. Chilkat HTTP will
520
+ * follow these instructions unless this property is set to `true`. The default value of this
521
+ * property is `false`.
522
+ *
523
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
524
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
525
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
526
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
527
+ * {@link Http.ignoreMustRevalidate},
528
+ * {@link Http.ignoreNoCache},
529
+ * and {@link Http.lastFromCache}.
530
+ */
531
+ ignoreNoCache: boolean
532
+
533
+ /**
534
+ * If set to `true`, the response body, if it is text, is stored in the {@link
535
+ * Http.lastResponseBody} property for methods **not** returning an `HttpResponse` object. By
536
+ * default, this property is `false`.
537
+ *
538
+ * Note: Many methods provide an `HttpResponse` object as their final output argument.
539
+ */
540
+ keepResponseBody: boolean
541
+
542
+ /**
543
+ * The LMFactor is an integer between 1 and 100 that specifies the percentage of time from an HTTP
544
+ * page's last-modified date to be used as the freshness period. The **default is 25**. For
545
+ * instance, if a page's last-modified date is 4 weeks ago and LMFactor is set to 25, the page
546
+ * will remain fresh in the cache for 1 week (25% of 4 weeks).
547
+ *
548
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
549
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
550
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
551
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
552
+ * {@link Http.ignoreMustRevalidate},
553
+ * {@link Http.ignoreNoCache},
554
+ * and {@link Http.lastFromCache}.
555
+ */
556
+ lmFactor: number
557
+
558
+ /**
559
+ * The `Content-Type` header value from the most recent HTTP response received.
560
+ *
561
+ * This property is read-only.
562
+ */
563
+ readonly lastContentType: string
564
+
565
+ /**
566
+ * Contains the text of the last HTTP header sent by any method.
567
+ *
568
+ * An **HTTP request** begins with a **start line** (called the \*status line\*), which contains
569
+ * the protocol version, status code, and reason phrase (e.g., `HTTP/1.1 200 OK`).
570
+ *
571
+ * After that comes the **header section**, made up of key–value pairs (like `Content-Type:
572
+ * text/html`).
573
+ *
574
+ * This property contains both the start line and the header section. For example:
575
+ *
576
+ * ```
577
+ * POST /echo_request_body.asp HTTP/1.1
578
+ * Host: chilkatsoft.com
579
+ * Accept: *\/*
580
+ * Accept-Encoding: gzip
581
+ * Content-Type: application/json
582
+ * Content-Length: 26
583
+ * ```
584
+ *
585
+ * This property is read-only.
586
+ */
587
+ readonly lastHeader: string
588
+
589
+ /**
590
+ * The `Last-Modified` header value from the most recent HTTP response received.
591
+ *
592
+ * This property is read-only.
593
+ */
594
+ readonly lastModDate: string
595
+
596
+ /**
597
+ * The response body from the last HTTP request is saved in this property only if the {@link
598
+ * Http.keepResponseBody} property is set to TRUE. This applies to methods that don't return an
599
+ * `HttpResponse` object.
600
+ *
601
+ * This property is read-only.
602
+ */
603
+ readonly lastResponseBody: string
604
+
605
+ /**
606
+ * Returns the most recent full response header for methods that do not use an `HttpResponse`
607
+ * object.
608
+ * For example:
609
+ *
610
+ * ```
611
+ * Content-Type: application/json
612
+ * Last-Modified: Sun, 20 Aug 2023 11:36:27 GMT
613
+ * Accept-Ranges: bytes
614
+ * ETag: "34c27f8e5ad3d91:0"
615
+ * Server: Microsoft-IIS/10.0
616
+ * X-Powered-By: ASP.NET
617
+ * Date: Sat, 30 Aug 2025 14:35:55 GMT
618
+ * Content-Length: 22
619
+ * ```
620
+ *
621
+ * This property is read-only.
622
+ */
623
+ readonly lastResponseHeader: string
624
+
625
+ /**
626
+ * Contains the most recent **response status code** for methods that don't utilize an
627
+ * `HttpResponse` object.
628
+ *
629
+ * This property is read-only.
630
+ */
631
+ readonly lastStatus: number
632
+
633
+ /**
634
+ * This is the login string to be used with HTTP `basic`, `digest`, or `NTLM` authentication.
635
+ */
636
+ login: string
637
+
638
+ /**
639
+ * The optional domain name to be used with NTLM authentication.
640
+ *
641
+ * In **NTLM HTTP authentication**, the **login domain** is the Windows domain that contains the
642
+ * user account.
643
+ *
644
+ * The client sends it in the NTLM messages (e.g., `DOMAIN\Username`) so the server knows which
645
+ * domain controller to contact to verify the credentials. If no domain is given, the server may
646
+ * fall back to checking local machine accounts.
647
+ */
648
+ loginDomain: string
649
+
650
+ /**
651
+ * This class automatically manages simultaneous open HTTP connections. If the maximum number of
652
+ * connections is reached, the least recently active connection is automatically closed. The
653
+ * default value is `10`.
654
+ *
655
+ * An **HTTP connection** can remain open if the client and server use **persistent connections**
656
+ * (e.g., `Connection: keep-alive` in HTTP/1.1).
657
+ *
658
+ * This allows multiple requests and responses to be sent over the same TLS connection instead of
659
+ * opening a new one each time.
660
+ *
661
+ * **Reasons:**
662
+ *
663
+ * - Reduces latency (no repeated TLS handshakes).
664
+ *
665
+ * - Improves efficiency for sending many requests.
666
+ *
667
+ * Also see: {@link Http.closeAllConnections}
668
+ */
669
+ maxConnections: number
670
+
671
+ /**
672
+ * Sets a time limit for how long a document can remain fresh in the cache, measured in minutes,
673
+ * with a default value of 525,600 minutes (equivalent to 1 year).
674
+ *
675
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
676
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
677
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
678
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
679
+ * {@link Http.ignoreMustRevalidate},
680
+ * {@link Http.ignoreNoCache},
681
+ * and {@link Http.lastFromCache}.
682
+ */
683
+ maxFreshPeriod: number
684
+
685
+ /**
686
+ * Specify the maximum HTTP response size the program will accept. The `default value of 0 means`
687
+ * there is `no size limit`. This safeguard helps prevent receiving excessively large responses
688
+ * that could hang or crash the application.
689
+ */
690
+ maxResponseSize: number
691
+
692
+ /**
693
+ * Limit the length of URLs (including URL parameters) in HTTP requests by setting this property.
694
+ * The default value is `2000` characters.
695
+ */
696
+ maxUrlLen: number
697
+
698
+ /**
699
+ * Sets the minimum time a document stays fresh in the cache, with a **default of 30 minutes**.
700
+ *
701
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
702
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
703
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
704
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
705
+ * {@link Http.ignoreMustRevalidate},
706
+ * {@link Http.ignoreNoCache},
707
+ * and {@link Http.lastFromCache}.
708
+ */
709
+ minFreshPeriod: number
710
+
711
+ /**
712
+ * Set this property equal to `true` for Negotiate authentication.
713
+ *
714
+ * Note: The NegotiateAuth property is only available for the Microsoft Windows operating system.
715
+ */
716
+ negotiateAuth: boolean
717
+
718
+ /**
719
+ * Setting this property to `true` causes the HTTP component to use NTLM authentication (also
720
+ * known as IWA -- or Integrated Windows Authentication) when authentication with an HTTP server.
721
+ * The default value is `false`.
722
+ */
723
+ ntlmAuth: boolean
724
+
725
+ /**
726
+ * This setting determines the directory levels used under each cache root. The **default value is
727
+ * 0**, meaning cached HTML pages are stored directly in the cache root directory.
728
+ *
729
+ * - **Level 0**: Cached pages are stored in the cache root directory.
730
+ *
731
+ * - **Level 1**: Cached pages go into one of 255 subdirectories (0 to 255) under the cache root.
732
+ *
733
+ * - **Level 2**: Two levels of subdirectories (0-255/0-255) are created under each cache root.
734
+ *
735
+ * The HTTP class automatically creates these subdirectories as needed. Multiple directory levels
736
+ * help prevent issues caused by having too many files in a single directory.
737
+ *
738
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
739
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
740
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
741
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
742
+ * {@link Http.ignoreMustRevalidate},
743
+ * {@link Http.ignoreNoCache},
744
+ * and {@link Http.lastFromCache}.
745
+ */
746
+ numCacheLevels: number
747
+
748
+ /**
749
+ * Specifies the number of established cache roots used by the HTTP cache to distribute the disk
750
+ * cache across multiple directories. Each cache root is an absolute directory path, set using the
751
+ * {@link Http.addCacheRoot} method.
752
+ *
753
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
754
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
755
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
756
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
757
+ * {@link Http.ignoreMustRevalidate},
758
+ * {@link Http.ignoreNoCache},
759
+ * and {@link Http.lastFromCache}.
760
+ *
761
+ * This property is read-only.
762
+ */
763
+ readonly numCacheRoots: number
764
+
765
+ /**
766
+ * If `true` then causes an OAuth Authorization header to be added to any request sent by the HTTP
767
+ * object. For example:
768
+ *
769
+ * ```
770
+ * Authorization: OAuth realm="http://sp.example.com/",
771
+ * oauth_consumer_key="0685bd9184jfhq22",
772
+ * oauth_token="ad180jjd733klru7",
773
+ * oauth_signature_method="HMAC-SHA1",
774
+ * oauth_signature="wOJIO9A2W5mFwDgiDvZbTSMK%2FPY%3D",
775
+ * oauth_timestamp="137131200",
776
+ * oauth_nonce="4572616e48616d6d65724c61686176",
777
+ * oauth_version="1.0"
778
+ * ```
779
+ *
780
+ * The information used to compute the OAuth Authorization header is obtained from the other
781
+ * OAuth\* properties, such as OAuthConsumerKey, OAuthConsumerSecret, OAuthRealm, etc.
782
+ */
783
+ oAuth1: boolean
784
+
785
+ /**
786
+ * The `OAuth 1.0a` callback URL. Defaults to `oob`.
787
+ *
788
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
789
+ */
790
+ oAuthCallback: string
791
+
792
+ /**
793
+ * The `OAuth1.0a` consumer key to be used in the `oauth_consumer_key` parameter of the
794
+ * `Authorization` header.
795
+ *
796
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
797
+ */
798
+ oAuthConsumerKey: string
799
+
800
+ /**
801
+ * The consumer secret to be used in computing the contents of the `OAuth1.0a` `Authorization`
802
+ * header.
803
+ *
804
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
805
+ */
806
+ oAuthConsumerSecret: string
807
+
808
+ /**
809
+ * The OAuth1.0a `realm` to be used in the `Authorization` header.
810
+ *
811
+ * The OAuth 1.0a realm parameter is an optional, descriptive string in the Authorization header
812
+ * that indicates the protected resources’ scope. It is **not required**, not included in the
813
+ * signature, and **rarely used** in real-world APIs. Most modern OAuth 1.0a integrations ignore
814
+ * it completely.
815
+ *
816
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
817
+ */
818
+ oAuthRealm: string
819
+
820
+ /**
821
+ * Specify the `oauth_signature_method` parameter in the `OAuth 1.0a Authorization header`. The
822
+ * default method is `HMAC-SHA1`, but it can be set to `HMAC-SHA256`, `RSA-SHA1`, or `RSA-SHA256`.
823
+ * For `RSA` methods, provide an RSA private key using the {@link Http.setOAuthRsaKey} method.
824
+ *
825
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
826
+ *
827
+ * Note that RSA-SHA256 is supported from Chilkat v9.5.0.56 onwards.
828
+ */
829
+ oAuthSigMethod: string
830
+
831
+ /**
832
+ * The value to be used for the `oauth_token` parameter in the `OAuth1.0a` `Authorization` header.
833
+ *
834
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
835
+ */
836
+ oAuthToken: string
837
+
838
+ /**
839
+ * The `OAuth1.0a` token secret to be used in computing the Authorization header.
840
+ *
841
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
842
+ */
843
+ oAuthTokenSecret: string
844
+
845
+ /**
846
+ * The value to be used for the verifier to be used in the `oauth_verifier` parameter of the
847
+ * `OAuth1.0a` `Authorization` header.
848
+ *
849
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
850
+ */
851
+ oAuthVerifier: string
852
+
853
+ /**
854
+ * The HTTP password for pages requiring a login/password. Chilkat HTTP can do Basic, Digest, and
855
+ * NTLM HTTP authentication. (NTLM is also known as SPA (or Windows Integrated Authentication). To
856
+ * use Basic authentication, the BasicAuth property must be set equal to `true`. It is not
857
+ * necessary to set the NtlmAuth or DigestAuth properties beforehand if NTLM or Digest
858
+ * authentication is needed. However, it is most efficient to pre-set these properties when the
859
+ * type of authentication is known in advance.
860
+ *
861
+ * **Note: **When the Login and Password properties are set, and the type of authentication is
862
+ * specified by setting one of the following properties equal to `true` (BasicAuth, DigestAuth,
863
+ * NtlmAuth), Chilkat will automatically add the `Authorization: ...` header in the correct
864
+ * format.
865
+ */
866
+ password: string
867
+
868
+ /**
869
+ * This property is only valid in programming environment and languages that allow for event
870
+ * callbacks.
871
+ *
872
+ * Sets the value to be defined as 100% complete for the purpose of PercentDone event callbacks.
873
+ * The defaut value of 100 means that at most 100 event PercentDone callbacks will occur in a
874
+ * method that (1) is event enabled and (2) is such that it is possible to measure progress as a
875
+ * percentage completed. This property may be set to larger numbers to get more fine-grained
876
+ * PercentDone callbacks. For example, setting this property equal to 1000 will provide callbacks
877
+ * with .1 percent granularity. For example, a value of 453 would indicate 45.3% competed. This
878
+ * property is clamped to a minimum value of 10, and a maximum value of 100000.
879
+ */
880
+ percentDoneScale: number
881
+
882
+ /**
883
+ * If `true`, then use IPv6 over IPv4 when both are supported for a particular domain. The default
884
+ * value of this property is `false`, which will choose IPv4 over IPv6.
885
+ */
886
+ preferIpv6: boolean
887
+
888
+ /**
889
+ * Set this to `basic` if you know in advance that Basic authentication is to be used for the HTTP
890
+ * proxy. Otherwise leave this property unset. Note: It is not necessary to set this property. The
891
+ * HTTP component will automatically handle proxy authentication for any of the supported
892
+ * authentication methods: NTLM, Digest, or Basic. Setting this property equal to `basic` prevents
893
+ * the 407 response which is automatically handled internal to Chilkat and never seen by your
894
+ * application.
895
+ *
896
+ * **Note:** If NTLM authentication does not succeed, set the Global.DefaultNtlmVersion property
897
+ * equal to 1 and then retry.
898
+ */
899
+ proxyAuthMethod: string
900
+
901
+ /**
902
+ * The domain name of a proxy host if an HTTP proxy is used. This can also be set to an IP
903
+ * address.
904
+ */
905
+ proxyDomain: string
906
+
907
+ /**
908
+ * If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy
909
+ * login.
910
+ */
911
+ proxyLogin: string
912
+
913
+ /**
914
+ * The NTLM authentication domain (optional) if NTLM authentication is used.
915
+ */
916
+ proxyLoginDomain: string
917
+
918
+ /**
919
+ * If an HTTP proxy is used and it requires authentication, this property specifies the HTTP proxy
920
+ * password.
921
+ */
922
+ proxyPassword: string
923
+
924
+ /**
925
+ * The port number of a proxy server if an HTTP proxy is used.
926
+ */
927
+ proxyPort: number
928
+
929
+ /**
930
+ * The amount of time in seconds to wait before timing out when reading from an HTTP server. The
931
+ * ReadTimeout is the amount of time that needs to elapse while no additional data is forthcoming.
932
+ * During a long download, if the data stream halts for more than this amount, it will timeout.
933
+ * Otherwise, there is no limit on the length of time for the entire download.
934
+ *
935
+ * The default value is 60 seconds. Note: Prior to v9.5.0.76, the default was 20 seconds.
936
+ */
937
+ readTimeout: number
938
+
939
+ /**
940
+ * Indicates the HTTP verb, such as GET, POST, PUT, etc. to be used for a redirect when the
941
+ * FollowRedirects property is set to `true`. The default value of this property is `GET`. This
942
+ * will produce the same behavior as a web browser (such as FireFox). If this property is set to
943
+ * the empty string, then it will cause the same verb as the original HTTP request to be used.
944
+ *
945
+ * **Note:** Prior to version 9.5.0.44, the default value of this property was the empty string.
946
+ */
947
+ redirectVerb: string
948
+
949
+ /**
950
+ * If `true`, then the HTTP client will verify the server's SSL certificate. The certificate is
951
+ * expired, or if the cert's signature is invalid, the connection is not allowed. The default
952
+ * value of this property is `false`.
953
+ */
954
+ requireSslCertVerify: boolean
955
+
956
+ /**
957
+ * If set, then any HTTP response to any POST or GET, including downloads, will be rejected if the
958
+ * content-type in the response header does not match this setting. If the content-type does not
959
+ * match, only the header of the HTTP response is read, the connection to the HTTP server is
960
+ * closed, and the remainder of the response is never read.
961
+ *
962
+ * This property is empty (zero-length string) by default.
963
+ *
964
+ * Some typical content-types are `text/html`, `text/xml`, `image/gif`, `image/jpeg`,
965
+ * `application/zip`, `application/msword`, `application/pdf`, etc.
966
+ */
967
+ requiredContentType: string
968
+
969
+ /**
970
+ * If this property is `true`, cookies are automatically persisted to XML files in the directory
971
+ * specified by the CookiesDir property (or in memory if CookieDir = `memory`). Both CookiesDir
972
+ * and SaveCookies must be set for cookies to be persisted.
973
+ */
974
+ saveCookies: boolean
975
+
976
+ /**
977
+ * The buffer size to be used with the underlying TCP/IP socket for sending. The default value is
978
+ * 65535.
979
+ */
980
+ sendBufferSize: number
981
+
982
+ /**
983
+ * If `true`, then cookies previously persisted to the CookiesDir are automatically added to all
984
+ * HTTP requests. Only cookies matching the domain and path are added.
985
+ */
986
+ sendCookies: boolean
987
+
988
+ /**
989
+ * Enables file-based session logging. If set to a filename (or relative/absolute filepath), then
990
+ * the exact HTTP requests and responses are logged to a file. The file is created if it does not
991
+ * already exist, otherwise it is appended.
992
+ */
993
+ sessionLogFilename: string
994
+
995
+ /**
996
+ * Sets the receive buffer size socket option. Normally, this property should be left unchanged.
997
+ * The default value is 4194304.
998
+ *
999
+ * This property can be increased if download performance seems slow. It is recommended to be a
1000
+ * multiple of 4096.
1001
+ */
1002
+ soRcvBuf: number
1003
+
1004
+ /**
1005
+ * Sets the send buffer size socket option. Normally, this property should be left unchanged. The
1006
+ * default value is 262144.
1007
+ *
1008
+ * This property can be increased if upload performance seems slow. It is recommended to be a
1009
+ * multiple of 4096. Testing with sizes such as 512K and 1MB is reasonable.
1010
+ */
1011
+ soSndBuf: number
1012
+
1013
+ /**
1014
+ * The SOCKS4/SOCKS5 hostname or IPv4 address (in dotted decimal notation). This property is only
1015
+ * used if the SocksVersion property is set to 4 or 5).
1016
+ */
1017
+ socksHostname: string
1018
+
1019
+ /**
1020
+ * The SOCKS5 password (if required). The SOCKS4 protocol does not include the use of a password,
1021
+ * so this does not apply to SOCKS4.
1022
+ */
1023
+ socksPassword: string
1024
+
1025
+ /**
1026
+ * The SOCKS4/SOCKS5 proxy port. The default value is 1080.
1027
+ * This property only applies if a SOCKS proxy is used (if the SocksVersion property is set to 4
1028
+ * or 5).
1029
+ */
1030
+ socksPort: number
1031
+
1032
+ /**
1033
+ * The SOCKS4/SOCKS5 proxy username. This property is only used if the SocksVersion property is
1034
+ * set to 4 or 5).
1035
+ */
1036
+ socksUsername: string
1037
+
1038
+ /**
1039
+ * SocksVersion
1040
+ * May be set to one of the following integer values:
1041
+ *
1042
+ * **0** - No SOCKS proxy is used. This is the default.
1043
+ *
1044
+ * **4** - Connect via a SOCKS4 proxy.
1045
+ *
1046
+ * **5** - Connect via a SOCKS5 proxy.
1047
+ */
1048
+ socksVersion: number
1049
+
1050
+ /**
1051
+ * Provides a means for setting a list of ciphers that are allowed for SSL/TLS connections. The
1052
+ * default (empty string) indicates that all implemented ciphers are possible. The TLS ciphers
1053
+ * supported in Chilkat v9.5.0.55 and later are:
1054
+ *
1055
+ * ```
1056
+ * TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
1057
+ * TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
1058
+ * TLS_DHE_RSA_WITH_CHACHA20_POLY1305_SHA256
1059
+ * TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
1060
+ * TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
1061
+ * TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
1062
+ * TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
1063
+ * TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
1064
+ * TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
1065
+ * TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
1066
+ * TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
1067
+ * TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
1068
+ * TLS_DHE_RSA_WITH_AES_256_CBC_SHA
1069
+ * TLS_RSA_WITH_AES_256_CBC_SHA256
1070
+ * TLS_RSA_WITH_AES_256_GCM_SHA384
1071
+ * TLS_RSA_WITH_AES_256_CBC_SHA
1072
+ * TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
1073
+ * TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1074
+ * TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
1075
+ * TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
1076
+ * TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
1077
+ * TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
1078
+ * TLS_DHE_RSA_WITH_AES_128_CBC_SHA
1079
+ * TLS_RSA_WITH_AES_128_CBC_SHA256
1080
+ * TLS_RSA_WITH_AES_128_GCM_SHA256
1081
+ * TLS_RSA_WITH_AES_128_CBC_SHA
1082
+ * TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
1083
+ * TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
1084
+ * TLS_RSA_WITH_3DES_EDE_CBC_SHA
1085
+ * TLS_ECDHE_RSA_WITH_RC4_128_SHA
1086
+ * TLS_RSA_WITH_RC4_128_SHA
1087
+ * TLS_RSA_WITH_RC4_128_MD5
1088
+ * TLS_DHE_RSA_WITH_DES_CBC_SHA
1089
+ * TLS_RSA_WITH_DES_CBC_SHA
1090
+ * ```
1091
+ *
1092
+ * To restrict SSL/TLS connections to one or more specific ciphers, set this property to a
1093
+ * comma-separated list of ciphers such as `TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,
1094
+ * TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384`. The order should be in terms of preference, with the
1095
+ * preferred algorithms listed first. (Note that the client cannot specifically choose the
1096
+ * algorithm is picked because it is the server that chooses. The client simply provides the
1097
+ * server with a list from which to choose.)
1098
+ *
1099
+ * The property can also disallow connections with servers having certificates with RSA keys less
1100
+ * than a certain size. By default, server certificates having RSA keys of 512 bits or greater are
1101
+ * allowed. Add the keyword `rsa1024` to disallow connections with servers having keys smaller
1102
+ * than 1024 bits. Add the keyword `rsa2048` to disallow connections with servers having keys
1103
+ * smaller than 2048 bits.
1104
+ *
1105
+ * **Note:** Prior to Chilkat v9.5.0.55, it was not possible to explicitly list allowed cipher
1106
+ * suites. The deprecated means for indicating allowed ciphers was both incomplete and unprecise.
1107
+ * For example, the following keywords could be listed to allow matching ciphers: `aes256-cbc`,
1108
+ * `aes128-cbc`, `3des-cbc`, and `rc4`. These keywords will still be recognized, but programs
1109
+ * should be updated to explicitly list the allowed ciphers.
1110
+ *
1111
+ * **secure-renegotiation:** Starting in Chilkat v9.5.0.55, the keyword `secure-renegotiation` may
1112
+ * be added to require that all renegotions be done securely (as per RFC 5746).
1113
+ *
1114
+ * **best-practices:** Starting in Chilkat v9.5.0.55, this property may be set to the single
1115
+ * keyword `best-practices`. This will allow ciphers based on the current best practices. As new
1116
+ * versions of Chilkat are released, the best practices may change. Changes will be noted here.
1117
+ * The current best practices are:
1118
+ *
1119
+ * - If the server uses an RSA key, it must be 1024 bits or greater.
1120
+ *
1121
+ * - All renegotations must be secure renegotiations.
1122
+ *
1123
+ * - All ciphers using RC4, DES, or 3DES are disallowed.
1124
+ *
1125
+ * **Example:** The following string would restrict to 2 specific cipher suites, require RSA keys
1126
+ * to be 1024 bits or greater, and require secure renegotiations:
1127
+ * `TLS_DHE_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, rsa1024,
1128
+ * secure-renegotiation`
1129
+ */
1130
+ sslAllowedCiphers: string
1131
+
1132
+ /**
1133
+ * Selects the SSL/TLS protocol version to be used for connections. Possible values are:
1134
+ *
1135
+ * default
1136
+ *
1137
+ * TLS 1.3
1138
+ *
1139
+ * TLS 1.2
1140
+ *
1141
+ * TLS 1.1
1142
+ *
1143
+ * TLS 1.0
1144
+ *
1145
+ * SSL 3.0
1146
+ *
1147
+ * TLS 1.3 or higher
1148
+ *
1149
+ * TLS 1.2 or higher
1150
+ *
1151
+ * TLS 1.1 or higher
1152
+ *
1153
+ * TLS 1.0 or higher
1154
+ *
1155
+ * The default value is `default` which allows for the protocol to be selected dynamically at
1156
+ * runtime based on the requirements of the server. Choosing an exact protocol will cause the
1157
+ * connection to fail unless that exact protocol is negotiated. It is better to choose `X or
1158
+ * higher` than an exact protocol. The `default` is effectively `SSL 3.0 or higher`.
1159
+ */
1160
+ sslProtocol: string
1161
+
1162
+ /**
1163
+ * Allows for the HTTP response body to be streamed directly into a file. If this property is set,
1164
+ * then any method returning an HTTP response object will stream the response body directly to the
1165
+ * file path specified. The HTTP response object will still contain the response header. (This
1166
+ * property is useful when the HTTP response is too large to fit into memory.)
1167
+ */
1168
+ streamResponseBodyPath: string
1169
+
1170
+ /**
1171
+ * Contains the current or last negotiated TLS cipher suite. If no TLS connection has yet to be
1172
+ * established, or if a connection as attempted and failed, then this will be empty. A sample
1173
+ * cipher suite string looks like this: TLS_DHE_RSA_WITH_AES_256_CBC_SHA256.
1174
+ *
1175
+ * This property is read-only.
1176
+ */
1177
+ readonly tlsCipherSuite: string
1178
+
1179
+ /**
1180
+ * Specifies a set of pins for Public Key Pinning for TLS connections. This property lists the
1181
+ * expected SPKI fingerprints for the server certificates. If the server's certificate (sent
1182
+ * during the TLS handshake) does not match any of the SPKI fingerprints, then the TLS handshake
1183
+ * is aborted and the connection fails. The format of this string property is as follows:
1184
+ *
1185
+ * ```
1186
+ * hash_algorithm, encoding, SPKI_fingerprint_1, SPKI_fingerprint_2, ...
1187
+ * ```
1188
+ *
1189
+ * For example, the following string specifies a single sha256 base64-encoded SPKI fingerprint:
1190
+ *
1191
+ * ```
1192
+ * "sha256, base64, lKg1SIqyhPSK19tlPbjl8s02yChsVTDklQpkMCHvsTE="
1193
+ * ```
1194
+ *
1195
+ * This example specifies two SPKI fingerprints:
1196
+ *
1197
+ * ```
1198
+ * "sha256, base64, 4t37LpnGmrMEAG8HEz9yIrnvJV2euVRwCLb9EH5WZyI=, 68b0G5iqMvWVWvUCjMuhLEyekM5729PadtnU5tdXZKs="
1199
+ * ```
1200
+ *
1201
+ * Any of the following hash algorithms are allowed:.sha1, sha256, sha384, sha512, md2, md5,
1202
+ * haval, ripemd128, ripemd160,ripemd256, or ripemd320.
1203
+ *
1204
+ * The following encodings are allowed: base64, hex, and any of the encodings indicated in the
1205
+ * link below.
1206
+ */
1207
+ tlsPinSet: string
1208
+
1209
+ /**
1210
+ * Contains the current or last negotiated TLS protocol version. If no TLS connection has yet to
1211
+ * be established, or if a connection as attempted and failed, then this will be empty. Possible
1212
+ * values are `SSL 3.0`, `TLS 1.0`, `TLS 1.1`, `TLS 1.2`, and `TLS 1.3`.
1213
+ *
1214
+ * This property is read-only.
1215
+ */
1216
+ readonly tlsVersion: string
1217
+
1218
+ /**
1219
+ * Set this property to `true` to automatically updated with HTTP GET request responses. **Only
1220
+ * HTTP GET requests are cached.** HTTP responses containing `Set-Cookie` headers are never
1221
+ * cached. **The default value is `false`**.
1222
+ *
1223
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
1224
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
1225
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
1226
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
1227
+ * {@link Http.ignoreMustRevalidate},
1228
+ * {@link Http.ignoreNoCache},
1229
+ * and {@link Http.lastFromCache}.
1230
+ */
1231
+ updateCache: boolean
1232
+
1233
+ /**
1234
+ * If `true`, the proxy address/port used by Internet Explorer will also be used by Chilkat HTTP.
1235
+ * Note: This property only pays attention to the proxy address and port, and does not pay
1236
+ * attention to additional information such as IE proxy server exceptions.
1237
+ */
1238
+ useIEProxy: boolean
1239
+
1240
+ /**
1241
+ * This property sets the `User-Agent` header for all HTTP requests, except those sent by the
1242
+ * {@link Http.httpReq} and {@link Http.httpSReq} methods that use headers from an `HttpRequest`
1243
+ * object.
1244
+ *
1245
+ * By default, it is set to an empty string, meaning no `User-Agent` header is included.
1246
+ *
1247
+ * Setting this property is the same as calling {@link Http.setRequestHeader} with `User-Agent` as
1248
+ * the header field name.
1249
+ *
1250
+ * The **`User-Agent` HTTP header** is sent by the client to identify **the software making the
1251
+ * request** (browser, app, library, bot, etc.).
1252
+ *
1253
+ * Example:
1254
+ *
1255
+ * ```
1256
+ * MyApp/1.1
1257
+ * ```
1258
+ *
1259
+ * Note: Some web servers reject requests that do not include a `User-Agent`.
1260
+ */
1261
+ userAgent: string
1262
+
1263
+ /**
1264
+ * This shows whether the last HTTP request automatically followed a redirect. For more
1265
+ * information on redirection, see the {@link Http.followRedirects} and {@link
1266
+ * Http.finalRedirectUrl} properties.
1267
+ *
1268
+ * This property is read-only.
1269
+ */
1270
+ readonly wasRedirected: boolean
1271
+
1272
+ /**
1273
+ * When set to `false`, MIME header folding is not applied to request headers automatically. By
1274
+ * default, this setting is `true`. This property exists for rare instances when a server cannot
1275
+ * properly handle folded MIME headers.
1276
+ *
1277
+ * **MIME header folding** allows long header lines to be split across multiple lines for
1278
+ * readability.
1279
+ *
1280
+ * A folded line begins with **whitespace (space or tab)**, which signals continuation.
1281
+ *
1282
+ * **Unfolded (single line):**
1283
+ *
1284
+ * ```
1285
+ * Subject: This is a very long subject line that needs to be wrapped across lines
1286
+ * ```
1287
+ *
1288
+ * **Folded (wrapped for transport):**
1289
+ *
1290
+ * ```
1291
+ * Subject: This is a very long subject line
1292
+ * that needs to be wrapped across lines
1293
+ * ```
1294
+ *
1295
+ * When received, the folded version is **unfolded back into a single line** by removing the CRLF
1296
+ * + leading whitespace.
1297
+ */
1298
+ allowHeaderFolding: boolean
1299
+
1300
+ /**
1301
+ * Applications can set this property to the `OAuth2` `access_token` value to be sent in the
1302
+ * `Authorization: Bearer {access_token}` header for all requests. For `OAuth1.0a` tokens, use the
1303
+ * {@link Http.oAuthToken} property instead.
1304
+ *
1305
+ * Starting from `Chilkat v10.1.2`, this method can also accept a `JSON string` containing details
1306
+ * needed for automatic OAuth2 access token retrieval via the `Client Credentials` flow. The JSON
1307
+ * must include the `client secret`, `client ID`, `token endpoint`, and `scope(s)`. See the
1308
+ * example below for guidance. This feature is compatible with any OAuth2 provider that supports
1309
+ * the client credentials flow.
1310
+ */
1311
+ authToken: string
1312
+
1313
+ /**
1314
+ * Contains the latest **response status text** for methods that don't use an `HttpResponse`
1315
+ * object. The response status text appears after the status code in the first line of an HTTP
1316
+ * response. For example, in the HTTP response below, the status text is `OK`:
1317
+ *
1318
+ * ```
1319
+ * HTTP/1.1 200 OK
1320
+ * Content-Type: application/json
1321
+ * Last-Modified: Sun, 20 Aug 2023 11:36:27 GMT
1322
+ * Accept-Ranges: bytes
1323
+ * ETag: "34c27f8e5ad3d91:0"
1324
+ * Server: Microsoft-IIS/10.0
1325
+ * X-Powered-By: ASP.NET
1326
+ * Date: Sat, 30 Aug 2025 14:35:55 GMT
1327
+ * Content-Length: 22
1328
+ *
1329
+ * { "hello": "world" }
1330
+ * ```
1331
+ *
1332
+ * This property is read-only.
1333
+ */
1334
+ readonly lastStatusText: string
1335
+
1336
+ /**
1337
+ * This is a catch-all property to be used for uncommon needs. This property defaults to the empty
1338
+ * string and should typically remain empty. Can be set to a list of the following comma separated
1339
+ * keywords:
1340
+ *
1341
+ * - `QuickDisconnect` - Introduced in v9.5.0.77. In the call to CloseAllConnections, do not
1342
+ * disconnect cleanly. Instead just disconnect as quickly as possible.
1343
+ *
1344
+ * - `ProtectFromVpn` - Introduced in v9.5.0.80. On Android systems, will bypass any VPN that may
1345
+ * be installed or active.
1346
+ *
1347
+ * - `TlsNoClientRootCert` - Introduced in v9.5.0.82. Will exclude root CA certs from being
1348
+ * included in the client certificate chain that is sent to the server for client-side
1349
+ * authentication. This must be set prior to calling SetSslClientCert.
1350
+ *
1351
+ * - `AllowEmptyHeaders` - Introduced in v9.5.0.82. If present, an empty value string passed to
1352
+ * SetHeaderField will cause the header to be added with an empty value. Otherwise, for
1353
+ * historical purposes and backward compatibility, the header field is removed when an empty
1354
+ * value string is passed.
1355
+ *
1356
+ * - `AnsiLogin` - Introduced in v9.5.0.87. For HTTP basic authentication, the login and password
1357
+ * is sent using the utf-8 byte representation. Some servers expect the ANSI byte representation
1358
+ * (typically Windows-1252). Use this keyword to send the login/password using ANSI.
1359
+ */
1360
+ uncommonOptions: string
1361
+
1362
+ /**
1363
+ * Sets the SNI hostname for the TLS ClientHello. This property is usually necessary only when the
1364
+ * domain is specified by an IP address and an SNI hostname is required. By default Chilkat uses
1365
+ * the hostname in the URL for the SNI hostname in the TLS ClientHello extension automatically.
1366
+ */
1367
+ sniHostname: string
1368
+
1369
+ /**
1370
+ * Set to `true` if the proxy server expects a direct TLS connection. (This is where the initial
1371
+ * connection to the HTTP proxy server is TLS. See [Squid Direct TLS
1372
+ * Connection](https://wiki.squid-cache.org/Features/HTTPS). The default value of this property is
1373
+ * `false`.
1374
+ */
1375
+ proxyDirectTls: boolean
1376
+
1377
+ /**
1378
+ * This property can be set to a JSON string containing the required information to add an `HTTP
1379
+ * Signature` in the following format:
1380
+ *
1381
+ * ```
1382
+ * Authorization: Signature
1383
+ * keyId="my-key-1",
1384
+ * algorithm="hmac-sha256",
1385
+ * headers="(request-target) host date",
1386
+ * signature="Base64OfSignature"
1387
+ * ```
1388
+ *
1389
+ * See the linked example below for details.
1390
+ */
1391
+ authSignature: string
1392
+
1393
+ /**
1394
+ * When set to `true`, the `oauth_body_hash`, which contains the `SHA-256` hash of the HTTP
1395
+ * request body, is automatically included in the `OAuth1.0a Authorization header`.
1396
+ *
1397
+ * For example:
1398
+ *
1399
+ * ```
1400
+ * Authorization: OAuth oauth_consumer_key="***",
1401
+ * oauth_nonce="A2E91C3B53E0BD7FBF71F441336679E358DDCEEE",
1402
+ * oauth_body_hash="a5kPTsDwUwmBjC0voNlAAvM6YoaRS5X7sTO49jl3/h8=",
1403
+ * oauth_timestamp="1756324932",
1404
+ * oauth_signature_method="RSA-SHA256",
1405
+ * oauth_version="1.0",
1406
+ * oauth_signature="****"
1407
+ * ```
1408
+ *
1409
+ * This property is only used when the {@link Http.oAuth1} property equals `true`.
1410
+ */
1411
+ oAuthBodyHash: boolean
1412
+
1413
+ /**
1414
+ * `true` if the last GET was fetched from cache.
1415
+ *
1416
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
1417
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
1418
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
1419
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
1420
+ * {@link Http.ignoreMustRevalidate},
1421
+ * {@link Http.ignoreNoCache},
1422
+ * and {@link Http.lastFromCache}.
1423
+ *
1424
+ * This property is read-only.
1425
+ */
1426
+ readonly lastFromCache: boolean
1427
+
1428
+ /**
1429
+ * Indicates whether the last HTTPS connection received a TLS CertificateRequest handshake message
1430
+ * indicating that the server may require a client certificate.
1431
+ *
1432
+ * This property is read-only.
1433
+ */
1434
+ readonly receivedCertReq: boolean
1435
+
1436
+ /**
1437
+ * This is the AWS session token for temporary security credentials.
1438
+ *
1439
+ * When you call **`AssumeRole`** with AWS STS, you get **temporary security credentials**
1440
+ * consisting of:
1441
+ *
1442
+ * - **Access key ID**
1443
+ *
1444
+ * - **Secret access key**
1445
+ *
1446
+ * - **Session token**
1447
+ *
1448
+ * The **session token** is an extra credential that must be included with the access key and
1449
+ * secret key when signing requests. It proves the credentials came from STS and are valid for the
1450
+ * limited session duration.
1451
+ *
1452
+ * In short: **The AWS session token is a required component of temporary STS credentials, used
1453
+ * alongside the key pair to authenticate API calls.**
1454
+ */
1455
+ awsSessionToken: string
1456
+
1457
+ /**
1458
+ * If `true`, then the hostname/domain in the URL must match at least one of the entries in the
1459
+ * server certificate's SAN. A SAN (Subject Alternative Name) field in an SSL/TLS certificate
1460
+ * contains a list of additional domain names, subdomains, IP addresses, or other identifiers that
1461
+ * the certificate is valid for.
1462
+ *
1463
+ * In actuality, it is the SNI hostname in the TLS handshake that must match a SAN entry. By
1464
+ * default, Chilkat uses the hostname from the URL as the SNI hostname. An application can
1465
+ * explicitly set the SNI hostname via the `SniHostname` property, which would be typical if
1466
+ * connecting via an IP address. See the example below.
1467
+ *
1468
+ * The default value is `false`.
1469
+ */
1470
+ requireHostnameMatch: boolean
1471
+
1472
+ /**
1473
+ * This property that automatic resolution of credentials from the operating system’s secure
1474
+ * storage.
1475
+ *
1476
+ * When set to `true`, the supported properties and methods (listed below) can accept a **secret
1477
+ * specification string** (beginning with `!!`) in place of a literal value. Chilkat detects this
1478
+ * format and retrieves the corresponding secret from:
1479
+ *
1480
+ * - **Windows Credential Manager** (Windows)
1481
+ *
1482
+ * - **Apple Keychain** (macOS)
1483
+ *
1484
+ * Secrets are identified using a structured string format:
1485
+ * `!![appName|]service[|domain]|username`
1486
+ *
1487
+ * Applies to {@link Http.awsAccessKey}, {@link Http.awsEndpoint}, {@link Http.awsRegion}, {@link
1488
+ * Http.awsSessionToken}, {@link Http.awsSecretKey}, {@link Http.proxyPassword}, {@link
1489
+ * Http.socksPassword}, {@link Http.password}.
1490
+ *
1491
+ * This feature allows applications to avoid embedding sensitive data directly in code by securely
1492
+ * resolving credentials at runtime.
1493
+ *
1494
+ * The default value is `false`
1495
+ */
1496
+ enableSecrets: boolean
1497
+
1498
+ // ---- Methods ----
1499
+
1500
+ /**
1501
+ * Disk caching operates similarly to browser caching of web pages, but it focuses on downloading
1502
+ * **web pages** rather than handling HTTP requests to a REST API.
1503
+ *
1504
+ * To activate disk caching, invoke the method at least once. Use the `AddCacheRoot` method and
1505
+ * provide a file path (e.g., `D:\MyHttpCache\`) to set the root directory. To distribute the
1506
+ * cache over multiple directories, call `AddCacheRoot` multiple times with different directory
1507
+ * paths.
1508
+ *
1509
+ * **HTTP GET web page caching** properties and methods include: {@link Http.numCacheRoots},
1510
+ * {@link Http.numCacheLevels}, {@link Http.addCacheRoot}, {@link Http.fetchFromCache}, {@link
1511
+ * Http.updateCache}, {@link Http.minFreshPeriod}, {@link Http.maxFreshPeriod},
1512
+ * {@link Http.freshnessAlgorithm}, {@link Http.defaultFreshPeriod}, {@link Http.lmFactor},
1513
+ * {@link Http.ignoreMustRevalidate},
1514
+ * {@link Http.ignoreNoCache},
1515
+ * and {@link Http.lastFromCache}.
1516
+ */
1517
+ addCacheRoot(dir: string): void
1518
+
1519
+ /**
1520
+ * Closes all remaining open HTTP connections.
1521
+ *
1522
+ * An HTTP object can hold up to 10 connections. If a server response lacks a `Connection: Close`
1523
+ * header, the connection stays open and may be reused for subsequent requests to the same host.
1524
+ * Connections are identified by their IP address or domain name as specified in the URL. Once the
1525
+ * limit of 10 connections is reached, the least recently used connection will be closed to open a
1526
+ * new one.
1527
+ *
1528
+ * Also see: {@link Http.maxConnections}.
1529
+ *
1530
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1531
+ * {@link Http.closeAllConnectionsAsync}.
1532
+ *
1533
+ * @throws Error if the call fails (the message names the reason); the full log is in
1534
+ * {@link Http.lastErrorText}.
1535
+ */
1536
+ closeAllConnections(): void
1537
+
1538
+ /**
1539
+ * Asynchronous form of {@link Http.closeAllConnections}: the same call on a native worker thread,
1540
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1541
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1542
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1543
+ *
1544
+ * The promise rejects with an Error if the call fails; the full log is in
1545
+ * {@link Http.lastErrorText}.
1546
+ */
1547
+ closeAllConnectionsAsync(): Promise<void>
1548
+
1549
+ /**
1550
+ * This function clears the Chilkat in-memory DNS cache, which stores hostname-to-IP address
1551
+ * mappings to avoid repeated DNS lookups.
1552
+ *
1553
+ * **Note:**
1554
+ *
1555
+ * -
1556
+ * The DNS cache is shared across all Chilkat objects, so clearing it will impact all such
1557
+ * objects.
1558
+ *
1559
+ * -
1560
+ * Chilkat's DNS caching respects the TTL (time to live) of DNS records. If the TTL has expired
1561
+ * since the initial lookup, Chilkat will perform a new DNS query and update the cache with the
1562
+ * latest IP address.
1563
+ */
1564
+ dnsCacheClear(): void
1565
+
1566
+ /**
1567
+ * Downloads the content at the specified `url` and saves to a local file at `localFilePath`.
1568
+ *
1569
+ * The download succeeds if the HTTP response status code is in the 200s. If unsuccessful, no
1570
+ * output file is created. If the {@link Http.keepResponseBody} property is set to `true`, the
1571
+ * server's error response will be available in the {@link Http.lastResponseBody} property.
1572
+ *
1573
+ * The response status code will be available in the {@link Http.lastStatus} property.
1574
+ *
1575
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1576
+ * {@link Http.downloadAsync}.
1577
+ *
1578
+ * @throws Error if the call fails (the message names the reason); the full log is in
1579
+ * {@link Http.lastErrorText}.
1580
+ */
1581
+ download(url: string, localFilePath: string): void
1582
+
1583
+ /**
1584
+ * Asynchronous form of {@link Http.download}: the same call on a native worker thread,
1585
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1586
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1587
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1588
+ *
1589
+ * The promise rejects with an Error if the call fails; the full log is in
1590
+ * {@link Http.lastErrorText}.
1591
+ */
1592
+ downloadAsync(url: string, localFilePath: string): Promise<void>
1593
+
1594
+ /**
1595
+ * Downloads the content at the specified `url` and appends to the local file at `appendToPath`.
1596
+ * The file is created if it does not yet exist.
1597
+ *
1598
+ * The download succeeds if the HTTP status code is in the 200s. If unsuccessful, no output file
1599
+ * is created. If the {@link Http.keepResponseBody} property is set to `true`, the server's error
1600
+ * response will be available in the {@link Http.lastResponseBody} property.
1601
+ *
1602
+ * The response status code will be available in the {@link Http.lastStatus} property.
1603
+ *
1604
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1605
+ * {@link Http.downloadAppendAsync}.
1606
+ *
1607
+ * @throws Error if the call fails (the message names the reason); the full log is in
1608
+ * {@link Http.lastErrorText}.
1609
+ */
1610
+ downloadAppend(url: string, appendToPath: string): void
1611
+
1612
+ /**
1613
+ * Asynchronous form of {@link Http.downloadAppend}: the same call on a native worker thread,
1614
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1615
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1616
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1617
+ *
1618
+ * The promise rejects with an Error if the call fails; the full log is in
1619
+ * {@link Http.lastErrorText}.
1620
+ */
1621
+ downloadAppendAsync(url: string, appendToPath: string): Promise<void>
1622
+
1623
+ /**
1624
+ * Fetches the content at `url` and returns the encoded hash using the specified algorithm
1625
+ * (`hashAlgorithm`: `sha1`, `sha256`, `sha384`, `sha512`, `md2`, `md5`, `haval`, `ripemd128`,
1626
+ * `ripemd160`, `ripemd256`, or `ripemd320`), and returns the hash encoded in the specified
1627
+ * encoding (`encoding`: `Base64`, `modBase64`, `Base32`, `UU`, `QP` for quoted-printable, `URL`
1628
+ * for URL-encoding, `Hex`, `Q`, `B`, `url_oath`, `url_rfc1738`, `url_rfc2396`, or `url_rfc3986`).
1629
+ *
1630
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1631
+ * {@link Http.downloadHashAsync}.
1632
+ *
1633
+ * @throws Error if the call fails (the message names the reason); the full log is in
1634
+ * {@link Http.lastErrorText}.
1635
+ */
1636
+ downloadHash(url: string, hashAlgorithm: string, encoding: string): string
1637
+
1638
+ /**
1639
+ * Asynchronous form of {@link Http.downloadHash}: the same call on a native worker thread,
1640
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1641
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1642
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1643
+ *
1644
+ * The promise rejects with an Error if the call fails; the full log is in
1645
+ * {@link Http.lastErrorText}.
1646
+ */
1647
+ downloadHashAsync(url: string, hashAlgorithm: string, encoding: string): Promise<string>
1648
+
1649
+ /**
1650
+ * This is a convenience method for extracting the META refresh URL from HTML. For example, if the
1651
+ * `htmlContent` contains a META refresh tag, such as:
1652
+ *
1653
+ * ```
1654
+ * _LT_meta http-equiv="refresh" content="5;URL='https://example.com/'"_GT_
1655
+ * ```
1656
+ *
1657
+ * Then the return value of this method would be `https://example.com/`.
1658
+ *
1659
+ * @throws Error if the call fails (the message names the reason); the full log is in
1660
+ * {@link Http.lastErrorText}.
1661
+ */
1662
+ extractMetaRefreshUrl(htmlContent: string): string
1663
+
1664
+ /**
1665
+ * Obtains a Google API OAuth2 access token for a service account. The `iss` is your service
1666
+ * account email address ending in `gserviceaccount.com`. The `scope` should be set to
1667
+ * `https://mail.google.com/` for GMail. The `subEmail` is your company email address, e.g.
1668
+ * `bob@yourcompany.com`. `numSec` is the number of seconds the access token will remain valid.
1669
+ *
1670
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1671
+ * {@link Http.gSvcOauthAccessTokenAsync}.
1672
+ *
1673
+ * @throws Error if the call fails (the message names the reason); the full log is in
1674
+ * {@link Http.lastErrorText}.
1675
+ */
1676
+ gSvcOauthAccessToken(iss: string, scope: string, subEmail: string, numSec: number, cert: Cert): string
1677
+
1678
+ /**
1679
+ * Asynchronous form of {@link Http.gSvcOauthAccessToken}: the same call on a native worker
1680
+ * thread,
1681
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1682
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1683
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1684
+ *
1685
+ * The promise rejects with an Error if the call fails; the full log is in
1686
+ * {@link Http.lastErrorText}.
1687
+ */
1688
+ gSvcOauthAccessTokenAsync(iss: string, scope: string, subEmail: string, numSec: number, cert: Cert): Promise<string>
1689
+
1690
+ /**
1691
+ * This method is similar to `G_SvcOauthAccessToken`, but offers greater customization. The first
1692
+ * three arguments of G_SvcOauthAccessToken are replaced with `claimParams` to allow for future
1693
+ * expansion with name-value parameters. See the example below.
1694
+ *
1695
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1696
+ * {@link Http.gSvcOauthAccessToken2Async}.
1697
+ *
1698
+ * @throws Error if the call fails (the message names the reason); the full log is in
1699
+ * {@link Http.lastErrorText}.
1700
+ */
1701
+ gSvcOauthAccessToken2(claimParams: Hashtable, numSec: number, cert: Cert): string
1702
+
1703
+ /**
1704
+ * Asynchronous form of {@link Http.gSvcOauthAccessToken2}: the same call on a native worker
1705
+ * thread,
1706
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1707
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1708
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1709
+ *
1710
+ * The promise rejects with an Error if the call fails; the full log is in
1711
+ * {@link Http.lastErrorText}.
1712
+ */
1713
+ gSvcOauthAccessToken2Async(claimParams: Hashtable, numSec: number, cert: Cert): Promise<string>
1714
+
1715
+ /**
1716
+ * Returns the current date and time in GMT (UTC) as a string formatted according to RFC 2616:
1717
+ * `Day, DD Mon YYYY HH:MM:SS GMT`. For example, `Thu, 21 Aug 2025 11:17:31 GMT`.
1718
+ *
1719
+ * @throws Error if the call fails (the message names the reason); the full log is in
1720
+ * {@link Http.lastErrorText}.
1721
+ */
1722
+ genTimeStamp(): string
1723
+
1724
+ /**
1725
+ * Returns the Nth cache root, with indexing starting at 0. Cache roots are established by calling
1726
+ * {@link Http.addCacheRoot} one or more times. The number of established cache roots is in the
1727
+ * {@link Http.numCacheRoots} property.
1728
+ *
1729
+ * @throws Error if the call fails (the message names the reason); the full log is in
1730
+ * {@link Http.lastErrorText}.
1731
+ */
1732
+ getCacheRoot(index: number): string
1733
+
1734
+ /**
1735
+ * Returns cookies in XML format for a specified domain. Cookies are saved only if the {@link
1736
+ * Http.saveCookies} property is set to `true`. If the {@link Http.cookieDir} property is set to
1737
+ * `memory,` cookies are stored in-memory.
1738
+ *
1739
+ * @throws Error if the call fails (the message names the reason); the full log is in
1740
+ * {@link Http.lastErrorText}.
1741
+ */
1742
+ getCookieXml(domain: string): string
1743
+
1744
+ /**
1745
+ * Utility method to extract the domain name from a URL. For instance, passing in
1746
+ * `https://chilkatsoft.com/refdoc/csharp.asp` will return `chilkatsoft.com`.
1747
+ *
1748
+ * @throws Error if the call fails (the message names the reason); the full log is in
1749
+ * {@link Http.lastErrorText}.
1750
+ */
1751
+ getDomain(url: string): string
1752
+
1753
+ /**
1754
+ * Returns the value of a header field previously set by calling {@link Http.setRequestHeader}.
1755
+ *
1756
+ * @throws Error if the call fails (the message names the reason); the full log is in
1757
+ * {@link Http.lastErrorText}.
1758
+ */
1759
+ getRequestHeader(name: string): string
1760
+
1761
+ /**
1762
+ * Returns the path part of a URL. For example, the path part of
1763
+ * `https://example.com/folder/page?lang=en&sort=asc#section2` is `/folder/page`.
1764
+ *
1765
+ * @throws Error if the call fails (the message names the reason); the full log is in
1766
+ * {@link Http.lastErrorText}.
1767
+ */
1768
+ getUrlPath(url: string): string
1769
+
1770
+ /**
1771
+ * Returns `true` if the header field specified by `name` is included in all HTTP requests, except
1772
+ * those sent by the {@link Http.httpReq} or {@link Http.httpSReq} methods.
1773
+ */
1774
+ hasRequestHeader(name: string): boolean
1775
+
1776
+ /**
1777
+ * This function sends an HTTP `DELETE` request to a specified URL and returns the response body
1778
+ * as a string.
1779
+ *
1780
+ * The HTTP response code is stored in the {@link Http.lastStatus} property, while additional
1781
+ * response details are available in properties such as {@link Http.lastResponseHeader}, {@link
1782
+ * Http.lastResponseBody}, {@link Http.lastModDate}, and {@link Http.lastContentType}.
1783
+ *
1784
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1785
+ * {@link Http.quickDeleteStrAsync}.
1786
+ *
1787
+ * @throws Error if the call fails (the message names the reason); the full log is in
1788
+ * {@link Http.lastErrorText}.
1789
+ */
1790
+ quickDeleteStr(url: string): string
1791
+
1792
+ /**
1793
+ * Asynchronous form of {@link Http.quickDeleteStr}: the same call on a native worker thread,
1794
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1795
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1796
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1797
+ *
1798
+ * The promise rejects with an Error if the call fails; the full log is in
1799
+ * {@link Http.lastErrorText}.
1800
+ */
1801
+ quickDeleteStrAsync(url: string): Promise<string>
1802
+
1803
+ /**
1804
+ * This function sends an HTTP `GET` request to a specified URL, which can include query
1805
+ * parameters, and returns the text response body.
1806
+ *
1807
+ * The response status code is stored in the {@link Http.lastStatus} property. Additional response
1808
+ * details can be found in properties like {@link Http.lastResponseHeader}, {@link
1809
+ * Http.lastModDate}, and {@link Http.lastContentType}.
1810
+ *
1811
+ * A response code of 400 or higher indicates a failure. If the error response is text-based and
1812
+ * the {@link Http.keepResponseBody} property is `true`, it will be available in the {@link
1813
+ * Http.lastResponseBody} property.
1814
+ *
1815
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1816
+ * {@link Http.quickGetStrAsync}.
1817
+ *
1818
+ * @throws Error if the call fails (the message names the reason); the full log is in
1819
+ * {@link Http.lastErrorText}.
1820
+ */
1821
+ quickGetStr(url: string): string
1822
+
1823
+ /**
1824
+ * Asynchronous form of {@link Http.quickGetStr}: the same call on a native worker thread,
1825
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1826
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1827
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1828
+ *
1829
+ * The promise rejects with an Error if the call fails; the full log is in
1830
+ * {@link Http.lastErrorText}.
1831
+ */
1832
+ quickGetStrAsync(url: string): Promise<string>
1833
+
1834
+ /**
1835
+ * Eliminates a header field from being included in all HTTP requests, except for those sent by
1836
+ * the {@link Http.httpReq} and {@link Http.httpSReq} methods, which rely on header fields
1837
+ * provided in an `HttpRequest` object via method arguments.
1838
+ */
1839
+ removeRequestHeader(name: string): void
1840
+
1841
+ /**
1842
+ * Builds the GET request that would be sent if a method such as {@link Http.quickGetStr} was
1843
+ * called. Instead of sending the request, it returns the HTTP request that would have been sent.
1844
+ *
1845
+ * @throws Error if the call fails (the message names the reason); the full log is in
1846
+ * {@link Http.lastErrorText}.
1847
+ */
1848
+ renderGet(url: string): string
1849
+
1850
+ /**
1851
+ * Resumes downloading content from `url` and saves it to a partially completed local file at
1852
+ * `targetFilename`. If the file at `targetFilename` doesn't exist or is empty, this method
1853
+ * functions the same as {@link Http.download}.
1854
+ *
1855
+ * The download succeeds if the HTTP response status code is in the 200s. If unsuccessful, no
1856
+ * output file is created. If the {@link Http.keepResponseBody} property is set to `true`, the
1857
+ * server's error response will be available in the {@link Http.lastResponseBody} property.
1858
+ *
1859
+ * The response status code will be available in the {@link Http.lastStatus} property.
1860
+ *
1861
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1862
+ * {@link Http.resumeDownloadAsync}.
1863
+ *
1864
+ * @throws Error if the call fails (the message names the reason); the full log is in
1865
+ * {@link Http.lastErrorText}.
1866
+ */
1867
+ resumeDownload(url: string, targetFilename: string): void
1868
+
1869
+ /**
1870
+ * Asynchronous form of {@link Http.resumeDownload}: the same call on a native worker thread,
1871
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1872
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1873
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1874
+ *
1875
+ * The promise rejects with an Error if the call fails; the full log is in
1876
+ * {@link Http.lastErrorText}.
1877
+ */
1878
+ resumeDownloadAsync(url: string, targetFilename: string): Promise<void>
1879
+
1880
+ /**
1881
+ * Creates a new Amazon S3 bucket.
1882
+ *
1883
+ * **
1884
+ *
1885
+ * Note:** You can add `x-amz-*` headers, including metadata, to any S3 request by using {@link
1886
+ * Http.setRequestHeader} for each header. This applies to all S3 methods, even if not explicitly
1887
+ * mentioned.
1888
+ *
1889
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1890
+ * {@link Http.s3CreateBucketAsync}.
1891
+ *
1892
+ * @throws Error if the call fails (the message names the reason); the full log is in
1893
+ * {@link Http.lastErrorText}.
1894
+ */
1895
+ s3CreateBucket(bucketPath: string): void
1896
+
1897
+ /**
1898
+ * Asynchronous form of {@link Http.s3CreateBucket}: the same call on a native worker thread,
1899
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1900
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1901
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1902
+ *
1903
+ * The promise rejects with an Error if the call fails; the full log is in
1904
+ * {@link Http.lastErrorText}.
1905
+ */
1906
+ s3CreateBucketAsync(bucketPath: string): Promise<void>
1907
+
1908
+ /**
1909
+ * Deletes an Amazon S3 bucket.
1910
+ *
1911
+ * **
1912
+ *
1913
+ * Note:** Ensure the {@link Http.awsEndpoint} property is set to the correct region if the bucket
1914
+ * is outside `us-east-1`, for example, `eu-central-1`. For S3-compatible services like `Wasabi`,
1915
+ * always set the {@link Http.awsEndpoint}, such as `s3.wasabisys.com` or
1916
+ * `s3.eu-central-1.wasabisys.com`.
1917
+ *
1918
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1919
+ * {@link Http.s3DeleteBucketAsync}.
1920
+ *
1921
+ * @throws Error if the call fails (the message names the reason); the full log is in
1922
+ * {@link Http.lastErrorText}.
1923
+ */
1924
+ s3DeleteBucket(bucketPath: string): void
1925
+
1926
+ /**
1927
+ * Asynchronous form of {@link Http.s3DeleteBucket}: the same call on a native worker thread,
1928
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1929
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1930
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1931
+ *
1932
+ * The promise rejects with an Error if the call fails; the full log is in
1933
+ * {@link Http.lastErrorText}.
1934
+ */
1935
+ s3DeleteBucketAsync(bucketPath: string): Promise<void>
1936
+
1937
+ /**
1938
+ * Deletes a remote file (object) on the Amazon S3 service.
1939
+ *
1940
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1941
+ * {@link Http.s3DeleteObjectAsync}.
1942
+ *
1943
+ * @throws Error if the call fails (the message names the reason); the full log is in
1944
+ * {@link Http.lastErrorText}.
1945
+ */
1946
+ s3DeleteObject(bucketPath: string, objectName: string): void
1947
+
1948
+ /**
1949
+ * Asynchronous form of {@link Http.s3DeleteObject}: the same call on a native worker thread,
1950
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1951
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1952
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1953
+ *
1954
+ * The promise rejects with an Error if the call fails; the full log is in
1955
+ * {@link Http.lastErrorText}.
1956
+ */
1957
+ s3DeleteObjectAsync(bucketPath: string, objectName: string): Promise<void>
1958
+
1959
+ /**
1960
+ * Downloads a file from the Amazon S3 service.
1961
+ *
1962
+ * **
1963
+ *
1964
+ * Note:** Ensure the {@link Http.awsEndpoint} property is set to the correct region if the bucket
1965
+ * is outside `us-east-1`, for example, `eu-central-1`. For S3-compatible services like `Wasabi`,
1966
+ * always set the {@link Http.awsEndpoint}, such as `s3.wasabisys.com` or
1967
+ * `s3.eu-central-1.wasabisys.com`.
1968
+ *
1969
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
1970
+ * {@link Http.s3DownloadFileAsync}.
1971
+ *
1972
+ * @throws Error if the call fails (the message names the reason); the full log is in
1973
+ * {@link Http.lastErrorText}.
1974
+ */
1975
+ s3DownloadFile(bucketPath: string, objectName: string, localFilePath: string): void
1976
+
1977
+ /**
1978
+ * Asynchronous form of {@link Http.s3DownloadFile}: the same call on a native worker thread,
1979
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
1980
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
1981
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
1982
+ *
1983
+ * The promise rejects with an Error if the call fails; the full log is in
1984
+ * {@link Http.lastErrorText}.
1985
+ */
1986
+ s3DownloadFileAsync(bucketPath: string, objectName: string, localFilePath: string): Promise<void>
1987
+
1988
+ /**
1989
+ * Downloads a text file (object) from the Amazon S3 service and returns the content as a string.
1990
+ * The `charset` specifies the character encoding, such as `utf-8`, of the remote text object.
1991
+ *
1992
+ * **
1993
+ *
1994
+ * Note:** Ensure the {@link Http.awsEndpoint} property is set to the correct region if the bucket
1995
+ * is outside `us-east-1`, for example, `eu-central-1`. For S3-compatible services like `Wasabi`,
1996
+ * always set the {@link Http.awsEndpoint}, such as `s3.wasabisys.com` or
1997
+ * `s3.eu-central-1.wasabisys.com`.
1998
+ *
1999
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2000
+ * {@link Http.s3DownloadStringAsync}.
2001
+ *
2002
+ * @throws Error if the call fails (the message names the reason); the full log is in
2003
+ * {@link Http.lastErrorText}.
2004
+ */
2005
+ s3DownloadString(bucketPath: string, objectName: string, charset: string): string
2006
+
2007
+ /**
2008
+ * Asynchronous form of {@link Http.s3DownloadString}: the same call on a native worker thread,
2009
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2010
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2011
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2012
+ *
2013
+ * The promise rejects with an Error if the call fails; the full log is in
2014
+ * {@link Http.lastErrorText}.
2015
+ */
2016
+ s3DownloadStringAsync(bucketPath: string, objectName: string, charset: string): Promise<string>
2017
+
2018
+ /**
2019
+ * Checks the existence of a remote file, returning:
2020
+ *
2021
+ * - 1 if the file exists
2022
+ *
2023
+ * - 0 if the file does not exist
2024
+ *
2025
+ * - -1 if the check failed
2026
+ *
2027
+ * - 2 if in asynchronous mode, indicating the background task started successfully
2028
+ *
2029
+ * **
2030
+ *
2031
+ * Note:** Ensure the {@link Http.awsEndpoint} property is set to the correct region if the bucket
2032
+ * is outside `us-east-1`, for example, `eu-central-1`. For S3-compatible services like `Wasabi`,
2033
+ * always set the {@link Http.awsEndpoint}, such as `s3.wasabisys.com` or
2034
+ * `s3.eu-central-1.wasabisys.com`.
2035
+ *
2036
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2037
+ * {@link Http.s3FileExistsAsync}.
2038
+ */
2039
+ s3FileExists(bucketPath: string, objectName: string): number
2040
+
2041
+ /**
2042
+ * Asynchronous form of {@link Http.s3FileExists}: the same call on a native worker thread,
2043
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2044
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2045
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2046
+ */
2047
+ s3FileExistsAsync(bucketPath: string, objectName: string): Promise<number>
2048
+
2049
+ /**
2050
+ * Retrieve an XML-formatted list of objects in an Amazon S3 bucket, similar to a directory
2051
+ * listing.
2052
+ *
2053
+ * `bucketPath` can include URL-encoded parameters. For example, to list objects in a bucket named
2054
+ * `ChilkatABC` with a max-keys value of `2000` and a marker of `xyz`, pass the following string
2055
+ * as `bucketPath` to the S3_ListBucketObjects method:
2056
+ * `ChilkatABC?max-keys=2000&marker=xyz`
2057
+ *
2058
+ * This method recognizes all parameters listed in the AWS documentation for bucket object
2059
+ * listing: `delimiter`, `marker`, `max-keys`, and `prefix`. For further details, refer to
2060
+ * Amazon's AWS online documentation.
2061
+ *
2062
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2063
+ * {@link Http.s3ListBucketObjectsAsync}.
2064
+ *
2065
+ * @throws Error if the call fails (the message names the reason); the full log is in
2066
+ * {@link Http.lastErrorText}.
2067
+ */
2068
+ s3ListBucketObjects(bucketPath: string): string
2069
+
2070
+ /**
2071
+ * Asynchronous form of {@link Http.s3ListBucketObjects}: the same call on a native worker thread,
2072
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2073
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2074
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2075
+ *
2076
+ * The promise rejects with an Error if the call fails; the full log is in
2077
+ * {@link Http.lastErrorText}.
2078
+ */
2079
+ s3ListBucketObjectsAsync(bucketPath: string): Promise<string>
2080
+
2081
+ /**
2082
+ * Retrieves the XML listing of the buckets for an Amazon S3 account.
2083
+ *
2084
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2085
+ * {@link Http.s3ListBucketsAsync}.
2086
+ *
2087
+ * @throws Error if the call fails (the message names the reason); the full log is in
2088
+ * {@link Http.lastErrorText}.
2089
+ */
2090
+ s3ListBuckets(): string
2091
+
2092
+ /**
2093
+ * Asynchronous form of {@link Http.s3ListBuckets}: the same call on a native worker thread,
2094
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2095
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2096
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2097
+ *
2098
+ * The promise rejects with an Error if the call fails; the full log is in
2099
+ * {@link Http.lastErrorText}.
2100
+ */
2101
+ s3ListBucketsAsync(): Promise<string>
2102
+
2103
+ /**
2104
+ * Uploads a file to the Amazon S3 service.
2105
+ *
2106
+ * Note: `x-amz-*` headers, including metadata, can be added to any S3 request by adding each
2107
+ * header with a call to {@link Http.setRequestHeader}. This applies to all S3 methods, even if
2108
+ * not explicitly stated.
2109
+ *
2110
+ * **
2111
+ *
2112
+ * Note:** Ensure the {@link Http.awsEndpoint} property is set to the correct region if the bucket
2113
+ * is outside `us-east-1`, for example, `eu-central-1`. For S3-compatible services like `Wasabi`,
2114
+ * always set the {@link Http.awsEndpoint}, such as `s3.wasabisys.com` or
2115
+ * `s3.eu-central-1.wasabisys.com`.
2116
+ *
2117
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2118
+ * {@link Http.s3UploadFileAsync}.
2119
+ *
2120
+ * @throws Error if the call fails (the message names the reason); the full log is in
2121
+ * {@link Http.lastErrorText}.
2122
+ */
2123
+ s3UploadFile(localFilePath: string, contentType: string, bucketPath: string, objectName: string): void
2124
+
2125
+ /**
2126
+ * Asynchronous form of {@link Http.s3UploadFile}: the same call on a native worker thread,
2127
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2128
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2129
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2130
+ *
2131
+ * The promise rejects with an Error if the call fails; the full log is in
2132
+ * {@link Http.lastErrorText}.
2133
+ */
2134
+ s3UploadFileAsync(localFilePath: string, contentType: string, bucketPath: string, objectName: string): Promise<void>
2135
+
2136
+ /**
2137
+ * Uploads the content of `objectContent` as a file to Amazon S3. `charset` specifies the string's
2138
+ * character encoding (byte representation).
2139
+ *
2140
+ * Note: `x-amz-*` headers, including metadata, can be added to any S3 request by adding each
2141
+ * header with a call to {@link Http.setRequestHeader}. This applies to all S3 methods, even if
2142
+ * not explicitly stated.
2143
+ *
2144
+ * **
2145
+ *
2146
+ * Note:** Ensure the {@link Http.awsEndpoint} property is set to the correct region if the bucket
2147
+ * is outside `us-east-1`, for example, `eu-central-1`. For S3-compatible services like `Wasabi`,
2148
+ * always set the {@link Http.awsEndpoint}, such as `s3.wasabisys.com` or
2149
+ * `s3.eu-central-1.wasabisys.com`.
2150
+ *
2151
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2152
+ * {@link Http.s3UploadStringAsync}.
2153
+ *
2154
+ * @throws Error if the call fails (the message names the reason); the full log is in
2155
+ * {@link Http.lastErrorText}.
2156
+ */
2157
+ s3UploadString(objectContent: string, charset: string, contentType: string, bucketPath: string, objectName: string): void
2158
+
2159
+ /**
2160
+ * Asynchronous form of {@link Http.s3UploadString}: the same call on a native worker thread,
2161
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2162
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2163
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2164
+ *
2165
+ * The promise rejects with an Error if the call fails; the full log is in
2166
+ * {@link Http.lastErrorText}.
2167
+ */
2168
+ s3UploadStringAsync(objectContent: string, charset: string, contentType: string, bucketPath: string, objectName: string): Promise<void>
2169
+
2170
+ /**
2171
+ * This method restores cookies for a specified domain. It requires that the cookies, previously
2172
+ * obtained using the {@link Http.getCookieXml} method, are stored in a persistent storage like a
2173
+ * database or file. An application can then restore these cookies using this method.
2174
+ *
2175
+ * @throws Error if the call fails (the message names the reason); the full log is in
2176
+ * {@link Http.lastErrorText}.
2177
+ */
2178
+ setCookieXml(domain: string, cookieXml: string): void
2179
+
2180
+ /**
2181
+ * Sets the RSA key to be used with `OAuth 1.0a` authentication when the {@link
2182
+ * Http.oAuthSigMethod} is `RSA-SHA256` or `RSA-SHA1`.
2183
+ *
2184
+ * @throws Error if the call fails (the message names the reason); the full log is in
2185
+ * {@link Http.lastErrorText}.
2186
+ */
2187
+ setOAuthRsaKey(privKey: PrivateKey): void
2188
+
2189
+ /**
2190
+ * Adds a header field to be included in all HTTP requests, except for those sent by the {@link
2191
+ * Http.httpReq} and {@link Http.httpSReq} methods, which rely on header fields provided in an
2192
+ * `HttpRequest` object via method arguments. If the header field already exists, it is replaced.
2193
+ *
2194
+ * Use the {@link Http.removeRequestHeader} method to delete a specific header. Setting a header
2195
+ * field to an empty string will also remove it, unless the `AllowEmptyHeaders` option in {@link
2196
+ * Http.uncommonOptions} is used.
2197
+ *
2198
+ * Avoid setting the `Authorization` header manually. Instead, use the appropriate authorization
2199
+ * properties such as {@link Http.password}, {@link Http.authToken}, {@link Http.authSignature},
2200
+ * {@link Http.basicAuth}, {@link Http.digestAuth}, {@link Http.ntlmAuth}, {@link Http.oAuth1},
2201
+ * {@link Http.oAuthToken}, etc.
2202
+ *
2203
+ * To add cookies, use the `Cookie` header field format: `Cookie: name1=value1; name2=value2;
2204
+ * name3=value3`.
2205
+ *
2206
+ * Do not manually set the `Content-Length` header. Chilkat will automatically calculate and
2207
+ * include `Content-Length` when sending the HTTP request.
2208
+ */
2209
+ setRequestHeader(headerFieldName: string, headerFieldValue: string): void
2210
+
2211
+ /**
2212
+ * Facilitates the use of a client-side certificate for a TLS connection, enabling mutual
2213
+ * authentication. In a standard TLS connection, the server alone presents a certificate during
2214
+ * the handshake to verify its identity. With mutual TLS (mTLS), the client also presents a
2215
+ * trusted certificate, allowing the server to authenticate the client's identity. This process
2216
+ * enhances security by adding a layer of verification beyond just usernames, passwords, or
2217
+ * tokens.
2218
+ *
2219
+ * @throws Error if the call fails (the message names the reason); the full log is in
2220
+ * {@link Http.lastErrorText}.
2221
+ */
2222
+ setSslClientCert(cert: Cert): void
2223
+
2224
+ /**
2225
+ * This is identical to the {@link Http.setSslClientCert} method, but it allows the certificate
2226
+ * with a private key to be in PEM format.
2227
+ *
2228
+ * @throws Error if the call fails (the message names the reason); the full log is in
2229
+ * {@link Http.lastErrorText}.
2230
+ */
2231
+ setSslClientCertPem(pemDataOrPath: string, pemPassword: string): void
2232
+
2233
+ /**
2234
+ * This is identical to the {@link Http.setSslClientCert} method, but enables you to provide a
2235
+ * certificate with private key directly from a .pfx or .p12 file.
2236
+ *
2237
+ * @throws Error if the call fails (the message names the reason); the full log is in
2238
+ * {@link Http.lastErrorText}.
2239
+ */
2240
+ setSslClientCertPfx(pfxPath: string, pfxPassword: string): void
2241
+
2242
+ /**
2243
+ * This method makes the calling process sleep for a specified number of milliseconds.
2244
+ */
2245
+ sleepMs(millisec: number): void
2246
+
2247
+ /**
2248
+ * URL decodes a string.
2249
+ *
2250
+ * @throws Error if the call fails (the message names the reason); the full log is in
2251
+ * {@link Http.lastErrorText}.
2252
+ */
2253
+ urlDecode(str: string): string
2254
+
2255
+ /**
2256
+ * URL encodes a string.
2257
+ *
2258
+ * @throws Error if the call fails (the message names the reason); the full log is in
2259
+ * {@link Http.lastErrorText}.
2260
+ */
2261
+ urlEncode(str: string): string
2262
+
2263
+ /**
2264
+ * Downloads content from `url` to `binData`, clearing `binData` beforehand. `binData` will only
2265
+ * contain the downloaded bytes if the operation is successful.
2266
+ *
2267
+ * The download succeeds if the HTTP status code is in the 200s. If unsuccessful, nothing is
2268
+ * written to `binData`. If the {@link Http.keepResponseBody} property is set to `true`, the
2269
+ * server's error response will be available in the {@link Http.lastResponseBody} property.
2270
+ *
2271
+ * The response status code will be available in the {@link Http.lastStatus} property.
2272
+ *
2273
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2274
+ * {@link Http.downloadBdAsync}.
2275
+ *
2276
+ * @throws Error if the call fails (the message names the reason); the full log is in
2277
+ * {@link Http.lastErrorText}.
2278
+ */
2279
+ downloadBd(url: string, binData: BinData): void
2280
+
2281
+ /**
2282
+ * Asynchronous form of {@link Http.downloadBd}: the same call on a native worker thread,
2283
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2284
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2285
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2286
+ *
2287
+ * The promise rejects with an Error if the call fails; the full log is in
2288
+ * {@link Http.lastErrorText}.
2289
+ */
2290
+ downloadBdAsync(url: string, binData: BinData): Promise<void>
2291
+
2292
+ /**
2293
+ * Downloads the content at the `url` into a Chilkat StringBuilder object. The `charset` tells
2294
+ * Chilkat how to interpret the bytes received. The `sb` is appended with the downloaded text
2295
+ * data.
2296
+ *
2297
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2298
+ * {@link Http.downloadSbAsync}.
2299
+ *
2300
+ * @throws Error if the call fails (the message names the reason); the full log is in
2301
+ * {@link Http.lastErrorText}.
2302
+ */
2303
+ downloadSb(url: string, charset: string, sb: StringBuilder): void
2304
+
2305
+ /**
2306
+ * Asynchronous form of {@link Http.downloadSb}: the same call on a native worker thread,
2307
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2308
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2309
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2310
+ *
2311
+ * The promise rejects with an Error if the call fails; the full log is in
2312
+ * {@link Http.lastErrorText}.
2313
+ */
2314
+ downloadSbAsync(url: string, charset: string, sb: StringBuilder): Promise<void>
2315
+
2316
+ /**
2317
+ * This function sends an HTTP `GET` request to a specified URL, which can include query
2318
+ * parameters, and returns the text response body in `sbContent`. The existing content of
2319
+ * `sbContent`, if any, is cleared and replaced with the downloaded content.
2320
+ *
2321
+ * The response status code is stored in the {@link Http.lastStatus} property. Additional response
2322
+ * details can be found in properties like {@link Http.lastResponseHeader}, {@link
2323
+ * Http.lastModDate}, and {@link Http.lastContentType}.
2324
+ *
2325
+ * If the response status code is \>= 400, then this method returns `false`, but the body of the
2326
+ * HTTP response is still returned in `sbContent`. This allows for the application to examine the
2327
+ * response body for cases where an error is returned, but the expected content is not received.
2328
+ *
2329
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2330
+ * {@link Http.quickGetSbAsync}.
2331
+ *
2332
+ * @throws Error if the call fails (the message names the reason); the full log is in
2333
+ * {@link Http.lastErrorText}.
2334
+ */
2335
+ quickGetSb(url: string, sbContent: StringBuilder): void
2336
+
2337
+ /**
2338
+ * Asynchronous form of {@link Http.quickGetSb}: the same call on a native worker thread,
2339
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2340
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2341
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2342
+ *
2343
+ * The promise rejects with an Error if the call fails; the full log is in
2344
+ * {@link Http.lastErrorText}.
2345
+ */
2346
+ quickGetSbAsync(url: string, sbContent: StringBuilder): Promise<void>
2347
+
2348
+ /**
2349
+ * This function sends an HTTP `GET` request to a specified URL, which can include query
2350
+ * parameters, and returns the binary response body in `binData`.
2351
+ *
2352
+ * The HTTP response code is stored in the {@link Http.lastStatus} property. Additional response
2353
+ * details can be found in properties like {@link Http.lastResponseHeader}, {@link
2354
+ * Http.lastModDate}, and {@link Http.lastContentType}.
2355
+ *
2356
+ * A response code of 400 or higher indicates a failure. If the error response is text-based and
2357
+ * the {@link Http.keepResponseBody} property is `true`, it will be available in the {@link
2358
+ * Http.lastResponseBody} property.
2359
+ *
2360
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2361
+ * {@link Http.quickGetBdAsync}.
2362
+ *
2363
+ * @throws Error if the call fails (the message names the reason); the full log is in
2364
+ * {@link Http.lastErrorText}.
2365
+ */
2366
+ quickGetBd(url: string, binData: BinData): void
2367
+
2368
+ /**
2369
+ * Asynchronous form of {@link Http.quickGetBd}: the same call on a native worker thread,
2370
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2371
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2372
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2373
+ *
2374
+ * The promise rejects with an Error if the call fails; the full log is in
2375
+ * {@link Http.lastErrorText}.
2376
+ */
2377
+ quickGetBdAsync(url: string, binData: BinData): Promise<void>
2378
+
2379
+ /**
2380
+ * Sets a variable's value for URL substitutions used in any method. Variables are formatted as
2381
+ * `{$varName}` in URLs, such as: `https://graph.microsoft.com/v1.0/users/{$id}`.
2382
+ *
2383
+ * Call {@link Http.clearUrlVars} to unset all URL variables.
2384
+ *
2385
+ * @throws Error if the call fails (the message names the reason); the full log is in
2386
+ * {@link Http.lastErrorText}.
2387
+ */
2388
+ setUrlVar(name: string, value: string): void
2389
+
2390
+ /**
2391
+ * Removes all URL variable values previously set by {@link Http.setUrlVar}.
2392
+ */
2393
+ clearUrlVars(): void
2394
+
2395
+ /**
2396
+ * This method authenticates with `SharePoint Online` and if successful, sets a cookie which is
2397
+ * used for all following SharePoint HTTP requests. Before using this method, ensure you configure
2398
+ * the {@link Http.cookieDir} property to either `memory` or a specific directory path to store
2399
+ * the authentication cookie, which will then be automatically used for subsequent HTTP requests.
2400
+ *
2401
+ * Using this method automatically sets the {@link Http.saveCookies} and {@link Http.sendCookies}
2402
+ * properties to `true`, as these settings are necessary for SharePoint Online authentication.
2403
+ *
2404
+ * To use the method, provide the following arguments:
2405
+ *
2406
+ * - `siteUrl`: The URL, e.g., <https://yourdomain.sharepoint.com/>
2407
+ *
2408
+ * - `username`: An email address, e.g., username@yourdomain.com
2409
+ *
2410
+ * - `password`: The Sharepoint password.
2411
+ *
2412
+ * - `extraInfo`: Can be an empty JSON object. Reserved for additional information if needed in
2413
+ * the future.
2414
+ *
2415
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2416
+ * {@link Http.sharePointOnlineAuthAsync}.
2417
+ *
2418
+ * @throws Error if the call fails (the message names the reason); the full log is in
2419
+ * {@link Http.lastErrorText}.
2420
+ */
2421
+ sharePointOnlineAuth(siteUrl: string, username: string, password: SecureString, extraInfo: JsonObject): void
2422
+
2423
+ /**
2424
+ * Asynchronous form of {@link Http.sharePointOnlineAuth}: the same call on a native worker
2425
+ * thread,
2426
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2427
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2428
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2429
+ *
2430
+ * The promise rejects with an Error if the call fails; the full log is in
2431
+ * {@link Http.lastErrorText}.
2432
+ */
2433
+ sharePointOnlineAuthAsync(siteUrl: string, username: string, password: SecureString, extraInfo: JsonObject): Promise<void>
2434
+
2435
+ /**
2436
+ * Resumes a download from where it left off, determined by the number of bytes in `binData`. This
2437
+ * method can be called multiple times until the download is complete.
2438
+ *
2439
+ * The download succeeds if the HTTP response status code is in the 200s. If unsuccessful, no
2440
+ * output file is created. If the {@link Http.keepResponseBody} property is set to `true`, the
2441
+ * server's error response will be available in the {@link Http.lastResponseBody} property.
2442
+ *
2443
+ * The response status code will be available in the {@link Http.lastStatus} property.
2444
+ *
2445
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2446
+ * {@link Http.resumeDownloadBdAsync}.
2447
+ *
2448
+ * @throws Error if the call fails (the message names the reason); the full log is in
2449
+ * {@link Http.lastErrorText}.
2450
+ */
2451
+ resumeDownloadBd(url: string, binData: BinData): void
2452
+
2453
+ /**
2454
+ * Asynchronous form of {@link Http.resumeDownloadBd}: the same call on a native worker thread,
2455
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2456
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2457
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2458
+ *
2459
+ * The promise rejects with an Error if the call fails; the full log is in
2460
+ * {@link Http.lastErrorText}.
2461
+ */
2462
+ resumeDownloadBdAsync(url: string, binData: BinData): Promise<void>
2463
+
2464
+ /**
2465
+ * Creates an RFC 3161 time-stamp request and returns the binary request token in
2466
+ * `timestampToken`. The `hashAlg` can be `sha1`, `sha256`, `sha384`, `sha512`, or `md5`, The
2467
+ * `hashVal` is the base64 hash of the data to be timestamped. The optional `reqPolicyOid` is the
2468
+ * requested policy OID in a format such as `1.3.6.1.4.1.47272.1.2`. The `addNonce` indicates
2469
+ * whether to auto-generate and include a nonce in the request. It may be `true` or `false`. The
2470
+ * `reqTsaCert` determines whether or not to request the TSA's certificate (`true` = Yes, `false`
2471
+ * = No).
2472
+ *
2473
+ * **
2474
+ *
2475
+ * Note:** After creating the timestamp request, send it to the server using {@link Http.httpBd}
2476
+ * with a `POST` request and a Content-Type of `application/timestamp-query`. Use {@link
2477
+ * Http.verifyTimestampReply} to analyze and verify the timestamp reply. See the examples linked
2478
+ * below.
2479
+ *
2480
+ * @throws Error if the call fails (the message names the reason); the full log is in
2481
+ * {@link Http.lastErrorText}.
2482
+ */
2483
+ createTimestampRequest(hashAlg: string, hashVal: string, reqPolicyOid: string, addNonce: boolean, reqTsaCert: boolean, timestampToken: BinData): void
2484
+
2485
+ /**
2486
+ * Verifies a timestamp reply received from a timestamp authority (TSA). Returns the following
2487
+ * possible integer values:
2488
+ *
2489
+ * - -1: The `timestampReply` does not contain a valid timestamp reply.
2490
+ *
2491
+ * - -2: The `timestampReply` is a valid timestamp reply, but failed verification using the public
2492
+ * key of the `tsaCert`.
2493
+ *
2494
+ * - 0: Granted and verified.
2495
+ *
2496
+ * - 1: Granted and verified, with mods (see RFC 3161)
2497
+ *
2498
+ * - 2: Rejected.
2499
+ *
2500
+ * - 3: Waiting.
2501
+ *
2502
+ * - 4: Revocation Warning
2503
+ *
2504
+ * - 5: Revocation Notification
2505
+ *
2506
+ * If the timestamp reply (`timestampReply`) is known to be from a trusted source, then the
2507
+ * `tsaCert` may be empty. If `tsaCert` is empty (never loaded with a certificate), then the
2508
+ * verification will use the certificate embedded in the timestamp reply.
2509
+ *
2510
+ * The {@link Http.createTimestampRequest} method is used to create a timestamp request.
2511
+ */
2512
+ verifyTimestampReply(timestampReply: BinData, tsaCert: Cert): number
2513
+
2514
+ /**
2515
+ * Generates an OCSP request for one or more certificates using JSON (`requestDetails`) that
2516
+ * specifies the request details. **Refer to the examples in the provided links** for guidance on
2517
+ * constructing the JSON. **
2518
+ *
2519
+ * Note:** After creating the OCSP request, send it to the server using {@link Http.httpBd} with a
2520
+ * `POST` request and a Content-Type of `application/ocsp-request`. Use {@link
2521
+ * Http.parseOcspReply} to analyze the OCSP response.
2522
+ *
2523
+ * @throws Error if the call fails (the message names the reason); the full log is in
2524
+ * {@link Http.lastErrorText}.
2525
+ */
2526
+ createOcspRequest(requestDetails: JsonObject, ocspRequest: BinData): void
2527
+
2528
+ /**
2529
+ * Parses an OCSP reply. Returns the following possible integer values:
2530
+ *
2531
+ * - -1: The `ocspReply` does not contain a valid OCSP reply.
2532
+ *
2533
+ * - 0: Successful - Response has valid confirmations..
2534
+ *
2535
+ * - 1: Malformed request - Illegal confirmation request.
2536
+ *
2537
+ * - 2: Internal error - Internal error in issuer.
2538
+ *
2539
+ * - 3: Try later - Try again later.
2540
+ *
2541
+ * - 4: Not used - This value is never returned.
2542
+ *
2543
+ * - 5: Sig required - Must sign the request.
2544
+ *
2545
+ * - 6: Unauthorized - Request unauthorized.
2546
+ *
2547
+ * The binaryOCSP reply is provided in `ocspReply`. The `replyData` is populated with data parsed
2548
+ * from `ocspReply`.
2549
+ *
2550
+ * OCSP requests are created by calling {@link Http.createOcspRequest}.
2551
+ */
2552
+ parseOcspReply(ocspReply: BinData, replyData: JsonObject): number
2553
+
2554
+ /**
2555
+ * Equivalent to setting the {@link Http.password} property but offers a more secure method by
2556
+ * using a secure string object.
2557
+ *
2558
+ * @throws Error if the call fails (the message names the reason); the full log is in
2559
+ * {@link Http.lastErrorText}.
2560
+ */
2561
+ setSecurePassword(password: SecureString): void
2562
+
2563
+ /**
2564
+ * Uploads the contents of `bd` as a file to the Amazon S3 service.
2565
+ *
2566
+ * Note: `x-amz-*` headers, including metadata, can be added to any S3 request by adding each
2567
+ * header with a call to {@link Http.setRequestHeader}. This applies to all S3 methods, even if
2568
+ * not explicitly stated.
2569
+ *
2570
+ * **
2571
+ *
2572
+ * Note:** Ensure the {@link Http.awsEndpoint} property is set to the correct region if the bucket
2573
+ * is outside `us-east-1`, for example, `eu-central-1`. For S3-compatible services like `Wasabi`,
2574
+ * always set the {@link Http.awsEndpoint}, such as `s3.wasabisys.com` or
2575
+ * `s3.eu-central-1.wasabisys.com`.
2576
+ *
2577
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2578
+ * {@link Http.s3UploadBdAsync}.
2579
+ *
2580
+ * @throws Error if the call fails (the message names the reason); the full log is in
2581
+ * {@link Http.lastErrorText}.
2582
+ */
2583
+ s3UploadBd(bd: BinData, contentType: string, bucketPath: string, objectName: string): void
2584
+
2585
+ /**
2586
+ * Asynchronous form of {@link Http.s3UploadBd}: the same call on a native worker thread,
2587
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2588
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2589
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2590
+ *
2591
+ * The promise rejects with an Error if the call fails; the full log is in
2592
+ * {@link Http.lastErrorText}.
2593
+ */
2594
+ s3UploadBdAsync(bd: BinData, contentType: string, bucketPath: string, objectName: string): Promise<void>
2595
+
2596
+ /**
2597
+ * Downloads a file from the Amazon S3 service into `bd`.
2598
+ *
2599
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2600
+ * {@link Http.s3DownloadBdAsync}.
2601
+ *
2602
+ * @throws Error if the call fails (the message names the reason); the full log is in
2603
+ * {@link Http.lastErrorText}.
2604
+ */
2605
+ s3DownloadBd(bucketPath: string, objectName: string, bd: BinData): void
2606
+
2607
+ /**
2608
+ * Asynchronous form of {@link Http.s3DownloadBd}: the same call on a native worker thread,
2609
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2610
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2611
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2612
+ *
2613
+ * The promise rejects with an Error if the call fails; the full log is in
2614
+ * {@link Http.lastErrorText}.
2615
+ */
2616
+ s3DownloadBdAsync(bucketPath: string, objectName: string, bd: BinData): Promise<void>
2617
+
2618
+ /**
2619
+ * Removes all headers set by the {@link Http.setRequestHeader} method.
2620
+ */
2621
+ clearHeaders(): void
2622
+
2623
+ /**
2624
+ * This method generates a temporary pre-signed URL for Amazon S3. Before calling this method,
2625
+ * ensure the following properties are set to valid values: {@link Http.awsSecretKey}, {@link
2626
+ * Http.awsAccessKey}, and {@link Http.awsRegion}. If the endpoint differs from
2627
+ * `s3.amazonaws.com`, set the {@link Http.awsEndpoint} property accordingly.
2628
+ *
2629
+ * `httpVerb` is the HTTP verb (e.g., `GET`, `PUT`, `POST`, `DELETE`). `awsService` is the name of
2630
+ * the AWS service (e.g., `s3`, `s3-accelerate`). If `useHttps` is `true`, the returned URL will
2631
+ * start with `https://`; otherwise, it will start with `http://`.
2632
+ *
2633
+ * The generated URL has this format:
2634
+ *
2635
+ * ```
2636
+ * https:////
2637
+ * ?X-Amz-Algorithm=AWS4-HMAC-SHA256
2638
+ * &X-Amz-Credential=////aws4_request
2639
+ * &X-Amz-Date=
2640
+ * &X-Amz-Expires=
2641
+ * &X-Amz-SignedHeaders=host
2642
+ * &X-Amz-Signature=
2643
+ * ```
2644
+ *
2645
+ * @throws Error if the call fails (the message names the reason); the full log is in
2646
+ * {@link Http.lastErrorText}.
2647
+ */
2648
+ s3GenPresignedUrl(httpVerb: string, useHttps: boolean, bucketName: string, path: string, numSecondsValid: number, awsService: string): string
2649
+
2650
+ /**
2651
+ * Enforces a requirement on the server's certificate. The `reqName` can be one of the following:
2652
+ *
2653
+ * - SubjectDN
2654
+ *
2655
+ * - SubjectCN
2656
+ *
2657
+ * - IssuerDN
2658
+ *
2659
+ * - IssuerCN
2660
+ *
2661
+ * - SAN
2662
+ *
2663
+ * The `reqName` specifies the part of the certificate, and the `reqValue` is the value that it
2664
+ * must match exactly or with a wildcard (\*), for example `"*.example.com"`. If the server's
2665
+ * certificate does not match, the SSL / TLS connection is aborted.
2666
+ */
2667
+ setSslCertRequirement(reqName: string, reqValue: string): void
2668
+
2669
+ /**
2670
+ * Gets the server certificate at a domain:port and then sends an OCSP request to the
2671
+ * certificate's OCSP URL to determine if the certificate has been revoked. Returns the OCSP
2672
+ * status, which has one of the following values:
2673
+ *
2674
+ * - -1: Unable to check. See the contents of the LastErrorText property for more informaiton.
2675
+ *
2676
+ * - 0: Good
2677
+ *
2678
+ * - 1: Revoked
2679
+ *
2680
+ * - 2: Unknown
2681
+ *
2682
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2683
+ * {@link Http.ocspCheckAsync}.
2684
+ */
2685
+ ocspCheck(domain: string, port: number): number
2686
+
2687
+ /**
2688
+ * Asynchronous form of {@link Http.ocspCheck}: the same call on a native worker thread,
2689
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2690
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2691
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2692
+ */
2693
+ ocspCheckAsync(domain: string, port: number): Promise<number>
2694
+
2695
+ /**
2696
+ * Sets the private key to be used with some forms of authentication. For example, this is used
2697
+ * automatically add the Authorization header (Signature) for `Amazon Pay` requests.
2698
+ *
2699
+ * @throws Error if the call fails (the message names the reason); the full log is in
2700
+ * {@link Http.lastErrorText}.
2701
+ */
2702
+ setAuthPrivateKey(publicKeyId: string, privKey: PrivateKey): void
2703
+
2704
+ /**
2705
+ * Sets the {@link Http.authToken} property. The `sb` contains the OAuth2 access token to be used.
2706
+ *
2707
+ * @throws Error if the call fails (the message names the reason); the full log is in
2708
+ * {@link Http.lastErrorText}.
2709
+ */
2710
+ setAuthTokenSb(sb: StringBuilder): void
2711
+
2712
+ /**
2713
+ * Offers details about the most recent method called on this object instance, although some
2714
+ * methods may not supply any information.
2715
+ */
2716
+ getLastJsonData(json: JsonObject): void
2717
+
2718
+ /**
2719
+ * Establishes an SSL/TLS connection with a web server to acquire its SSL certificate without
2720
+ * retrieving any data, then disconnects.
2721
+ *
2722
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2723
+ * {@link Http.getServerCertAsync}.
2724
+ *
2725
+ * @throws Error if the call fails (the message names the reason); the full log is in
2726
+ * {@link Http.lastErrorText}.
2727
+ */
2728
+ getServerCert(domain: string, port: number, cert: Cert): void
2729
+
2730
+ /**
2731
+ * Asynchronous form of {@link Http.getServerCert}: the same call on a native worker thread,
2732
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2733
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2734
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2735
+ *
2736
+ * The promise rejects with an Error if the call fails; the full log is in
2737
+ * {@link Http.lastErrorText}.
2738
+ */
2739
+ getServerCertAsync(domain: string, port: number, cert: Cert): Promise<void>
2740
+
2741
+ /**
2742
+ * Sends an HTTP request to `url` using the specified HTTP `verb` (e.g., `POST`, `PUT`, `PATCH`).
2743
+ * The body of the request is defined by `bd`, and the Content-Type header is set by
2744
+ * `contentType`, with possible values like `application/octet-stream`, `application/pdf`,
2745
+ * `image/jpeg`, or `application/zip`. The HTTP response is returned in `response`.
2746
+ *
2747
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2748
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2749
+ * response was received due to a communication error or another issue. In such cases, check the
2750
+ * LastErrorText property for details.
2751
+ *
2752
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2753
+ * {@link Http.httpBdAsync}.
2754
+ *
2755
+ * @throws Error if the call fails (the message names the reason); the full log is in
2756
+ * {@link Http.lastErrorText}.
2757
+ */
2758
+ httpBd(verb: string, url: string, bd: BinData, contentType: string, response: HttpResponse): void
2759
+
2760
+ /**
2761
+ * Asynchronous form of {@link Http.httpBd}: the same call on a native worker thread,
2762
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2763
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2764
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2765
+ *
2766
+ * The promise rejects with an Error if the call fails; the full log is in
2767
+ * {@link Http.lastErrorText}.
2768
+ */
2769
+ httpBdAsync(verb: string, url: string, bd: BinData, contentType: string, response: HttpResponse): Promise<void>
2770
+
2771
+ /**
2772
+ * Sends an HTTP request to `url` using the specified HTTP `verb`. The request body is empty.
2773
+ * Verbs like `GET`, `HEAD`, and `DELETE` usually do not include a body. No `Content-Type` header
2774
+ * is included because there is no content in the body of the request. The HTTP response is
2775
+ * returned in `response`.
2776
+ *
2777
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2778
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2779
+ * response was received due to a communication error or another issue. In such cases, check the
2780
+ * LastErrorText property for details.
2781
+ *
2782
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2783
+ * {@link Http.httpNoBodyAsync}.
2784
+ *
2785
+ * @throws Error if the call fails (the message names the reason); the full log is in
2786
+ * {@link Http.lastErrorText}.
2787
+ */
2788
+ httpNoBody(verb: string, url: string, response: HttpResponse): void
2789
+
2790
+ /**
2791
+ * Asynchronous form of {@link Http.httpNoBody}: the same call on a native worker thread,
2792
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2793
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2794
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2795
+ *
2796
+ * The promise rejects with an Error if the call fails; the full log is in
2797
+ * {@link Http.lastErrorText}.
2798
+ */
2799
+ httpNoBodyAsync(verb: string, url: string, response: HttpResponse): Promise<void>
2800
+
2801
+ /**
2802
+ * Sends an HTTP request to `url` using the specified verb (e.g., `POST`, `PUT`, `PATCH`). The
2803
+ * request body contains the text passed in `bodyStr`, and the content type is specified by
2804
+ * `contentType` (e.g., `text/xml`, `application/json`). The `charset` defines the text encoding,
2805
+ * such as `utf-8` or `iso-8859-1`. The HTTP response is returned in `response`.
2806
+ *
2807
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2808
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2809
+ * response was received due to a communication error or another issue. In such cases, check the
2810
+ * LastErrorText property for details.
2811
+ *
2812
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2813
+ * {@link Http.httpStrAsync}.
2814
+ *
2815
+ * @throws Error if the call fails (the message names the reason); the full log is in
2816
+ * {@link Http.lastErrorText}.
2817
+ */
2818
+ httpStr(verb: string, url: string, bodyStr: string, charset: string, contentType: string, response: HttpResponse): void
2819
+
2820
+ /**
2821
+ * Asynchronous form of {@link Http.httpStr}: the same call on a native worker thread,
2822
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2823
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2824
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2825
+ *
2826
+ * The promise rejects with an Error if the call fails; the full log is in
2827
+ * {@link Http.lastErrorText}.
2828
+ */
2829
+ httpStrAsync(verb: string, url: string, bodyStr: string, charset: string, contentType: string, response: HttpResponse): Promise<void>
2830
+
2831
+ /**
2832
+ * Sends an HTTP request to `url` using the specified `verb` (e.g., `POST`, `PUT`, `PATCH`). The
2833
+ * request body contains the text passed in `sb`, and the content type is specified by
2834
+ * `contentType` (e.g., `text/xml`, `application/json`). The `charset` defines the text encoding,
2835
+ * such as `utf-8` or `iso-8859-1`. The HTTP response is returned in `response`.
2836
+ *
2837
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2838
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2839
+ * response was received due to a communication error or another issue. In such cases, check the
2840
+ * LastErrorText property for details.
2841
+ *
2842
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2843
+ * {@link Http.httpSbAsync}.
2844
+ *
2845
+ * @throws Error if the call fails (the message names the reason); the full log is in
2846
+ * {@link Http.lastErrorText}.
2847
+ */
2848
+ httpSb(verb: string, url: string, sb: StringBuilder, charset: string, contentType: string, response: HttpResponse): void
2849
+
2850
+ /**
2851
+ * Asynchronous form of {@link Http.httpSb}: the same call on a native worker thread,
2852
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2853
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2854
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2855
+ *
2856
+ * The promise rejects with an Error if the call fails; the full log is in
2857
+ * {@link Http.lastErrorText}.
2858
+ */
2859
+ httpSbAsync(verb: string, url: string, sb: StringBuilder, charset: string, contentType: string, response: HttpResponse): Promise<void>
2860
+
2861
+ /**
2862
+ * Sends an HTTP request to `url` using the specified method in `verb` (e.g., POST, PUT, PATCH).
2863
+ * The request body contains the JSON from `json`, with the content type set by `contentType`,
2864
+ * such as `application/json` or `application/jsonrequest.` The HTTP response is returned in
2865
+ * `response`.
2866
+ *
2867
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2868
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2869
+ * response was received due to a communication error or another issue. In such cases, check the
2870
+ * LastErrorText property for details.
2871
+ *
2872
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2873
+ * {@link Http.httpJsonAsync}.
2874
+ *
2875
+ * @throws Error if the call fails (the message names the reason); the full log is in
2876
+ * {@link Http.lastErrorText}.
2877
+ */
2878
+ httpJson(verb: string, url: string, json: JsonObject, contentType: string, response: HttpResponse): void
2879
+
2880
+ /**
2881
+ * Asynchronous form of {@link Http.httpJson}: the same call on a native worker thread,
2882
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2883
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2884
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2885
+ *
2886
+ * The promise rejects with an Error if the call fails; the full log is in
2887
+ * {@link Http.lastErrorText}.
2888
+ */
2889
+ httpJsonAsync(verb: string, url: string, json: JsonObject, contentType: string, response: HttpResponse): Promise<void>
2890
+
2891
+ /**
2892
+ * Sends an HTTP request to `url` where the content of the request is defined by `request`. The
2893
+ * path and query part of target is taken from the `url` instead of the path property within
2894
+ * `request`.
2895
+ *
2896
+ * ```
2897
+ * scheme host path query
2898
+ * ┌────┐ ┌─────────┐┌──────────────┐ ┌────────┐
2899
+ * https://example.com/docs/index.html?search=test
2900
+ * ```
2901
+ *
2902
+ * The HTTP response is returned in `response`.
2903
+ *
2904
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2905
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2906
+ * response was received due to a communication error or another issue. In such cases, check the
2907
+ * LastErrorText property for details.
2908
+ *
2909
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2910
+ * {@link Http.httpReqAsync}.
2911
+ *
2912
+ * @throws Error if the call fails (the message names the reason); the full log is in
2913
+ * {@link Http.lastErrorText}.
2914
+ */
2915
+ httpReq(url: string, request: HttpRequest, response: HttpResponse): void
2916
+
2917
+ /**
2918
+ * Asynchronous form of {@link Http.httpReq}: the same call on a native worker thread,
2919
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2920
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2921
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2922
+ *
2923
+ * The promise rejects with an Error if the call fails; the full log is in
2924
+ * {@link Http.lastErrorText}.
2925
+ */
2926
+ httpReqAsync(url: string, request: HttpRequest, response: HttpResponse): Promise<void>
2927
+
2928
+ /**
2929
+ * Sends an HTTP request to `url` using the specified HTTP `verb` (e.g., `POST`, `PUT`, `PATCH`).
2930
+ * The body of the request is streamed directly from `localFilePath`, and the Content-Type header
2931
+ * is set by `contentType`, with possible values like `application/octet-stream`,
2932
+ * `application/pdf`, `image/jpeg`, or `application/zip`. The HTTP response is returned in
2933
+ * `response`.
2934
+ *
2935
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2936
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2937
+ * response was received due to a communication error or another issue. In such cases, check the
2938
+ * LastErrorText property for details.
2939
+ *
2940
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2941
+ * {@link Http.httpFileAsync}.
2942
+ *
2943
+ * @throws Error if the call fails (the message names the reason); the full log is in
2944
+ * {@link Http.lastErrorText}.
2945
+ */
2946
+ httpFile(verb: string, url: string, localFilePath: string, contentType: string, response: HttpResponse): void
2947
+
2948
+ /**
2949
+ * Asynchronous form of {@link Http.httpFile}: the same call on a native worker thread,
2950
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2951
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2952
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2953
+ *
2954
+ * The promise rejects with an Error if the call fails; the full log is in
2955
+ * {@link Http.lastErrorText}.
2956
+ */
2957
+ httpFileAsync(verb: string, url: string, localFilePath: string, contentType: string, response: HttpResponse): Promise<void>
2958
+
2959
+ /**
2960
+ * Sends an HTTP `verb` request to `url` with query parameters from `json`. The request has an
2961
+ * empty body, and therefore, no `Content-Type` header is included. Typically, verbs such as
2962
+ * `GET`, `HEAD`, and `DELETE` do not require a body. Applications generally call this method with
2963
+ * `url`, while passing query parameters separately in `json`. See the example below. The HTTP
2964
+ * response is returned in `response`.
2965
+ *
2966
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
2967
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
2968
+ * response was received due to a communication error or another issue. In such cases, check the
2969
+ * LastErrorText property for details.
2970
+ *
2971
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
2972
+ * {@link Http.httpParamsAsync}.
2973
+ *
2974
+ * @throws Error if the call fails (the message names the reason); the full log is in
2975
+ * {@link Http.lastErrorText}.
2976
+ */
2977
+ httpParams(verb: string, url: string, json: JsonObject, response: HttpResponse): void
2978
+
2979
+ /**
2980
+ * Asynchronous form of {@link Http.httpParams}: the same call on a native worker thread,
2981
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
2982
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
2983
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
2984
+ *
2985
+ * The promise rejects with an Error if the call fails; the full log is in
2986
+ * {@link Http.lastErrorText}.
2987
+ */
2988
+ httpParamsAsync(verb: string, url: string, json: JsonObject, response: HttpResponse): Promise<void>
2989
+
2990
+ /**
2991
+ * Sends an HTTP request to web server at `domain`:`port` using TLS if `ssl` equals `true`. The
2992
+ * content of the request, including the path part of the URL, query params, additional headers,
2993
+ * and request body is defined by `request`.
2994
+ *
2995
+ * Note: The `domain` should include only the domain (host), not the complete URL. The path and
2996
+ * query params are defined in the `request` object.
2997
+ *
2998
+ * ```
2999
+ * scheme host path query
3000
+ * ┌────┐ ┌─────────┐┌──────────────┐ ┌────────┐
3001
+ * https://example.com/docs/index.html?search=test
3002
+ * ```
3003
+ *
3004
+ * `response` contains the HTTP response.
3005
+ *
3006
+ * This method returns `false` for HTTP response status codes of `400` or higher, but the response
3007
+ * object is still provided in `response`. If `response`'s status code is `0`, it indicates no
3008
+ * response was received due to a communication error or another issue. In such cases, check the
3009
+ * LastErrorText property for details.
3010
+ *
3011
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3012
+ * {@link Http.httpSReqAsync}.
3013
+ *
3014
+ * @throws Error if the call fails (the message names the reason); the full log is in
3015
+ * {@link Http.lastErrorText}.
3016
+ */
3017
+ httpSReq(domain: string, port: number, ssl: boolean, request: HttpRequest, response: HttpResponse): void
3018
+
3019
+ /**
3020
+ * Asynchronous form of {@link Http.httpSReq}: the same call on a native worker thread,
3021
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3022
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
3023
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
3024
+ *
3025
+ * The promise rejects with an Error if the call fails; the full log is in
3026
+ * {@link Http.lastErrorText}.
3027
+ */
3028
+ httpSReqAsync(domain: string, port: number, ssl: boolean, request: HttpRequest, response: HttpResponse): Promise<void>
3029
+
3030
+ /**
3031
+ * Deletes several objects from a bucket with a single request. `objectNames` includes the object
3032
+ * names (or `keys`) to be deleted. To delete a specific object version, add a versionId to the
3033
+ * object name, like this: `SampleDocument.txt; VersionId=OYcLXagmS.WaD..oyH4KRguB95_YhLs7`. If
3034
+ * successful, `jsonResponse` will contain the JSON response.
3035
+ *
3036
+ * This call blocks the JavaScript thread until Chilkat returns; from UI code prefer
3037
+ * {@link Http.s3DeleteObjectsAsync}.
3038
+ *
3039
+ * @throws Error if the call fails (the message names the reason); the full log is in
3040
+ * {@link Http.lastErrorText}.
3041
+ */
3042
+ s3DeleteObjects(bucketName: string, objectNames: StringTable, jsonResponse: JsonObject): void
3043
+
3044
+ /**
3045
+ * Asynchronous form of {@link Http.s3DeleteObjects}: the same call on a native worker thread,
3046
+ * settling on the JavaScript thread. While it is pending, other calls on this object throw,
3047
+ * except {@link Http.abort} (which cancels it) and the {@link Http.onPercentDone} /
3048
+ * {@link Http.onProgressInfo} callbacks, which report progress while it runs.
3049
+ *
3050
+ * The promise rejects with an Error if the call fails; the full log is in
3051
+ * {@link Http.lastErrorText}.
3052
+ */
3053
+ s3DeleteObjectsAsync(bucketName: string, objectNames: StringTable, jsonResponse: JsonObject): Promise<void>
3054
+
3055
+ /**
3056
+ * Clears all in-memory cookies accumulated while the {@link Http.saveCookies} property was set to
3057
+ * `true` and the {@link Http.cookieDir} was set to `memory`.
3058
+ */
3059
+ clearInMemoryCookies(): void
3060
+
3061
+ /**
3062
+ * Sets the EC private key for automatically adding the DPoP header to HTTP requests. Chilkat will
3063
+ * generate a JWT for each request and include the `DPoP` header. Ensure the AuthToken property is
3064
+ * also set.
3065
+ *
3066
+ * @throws Error if the call fails (the message names the reason); the full log is in
3067
+ * {@link Http.lastErrorText}.
3068
+ */
3069
+ setDPoPKey(privKey: PrivateKey): void
3070
+
3071
+ // ---- Events (ReactNativeGen_DESIGN.md §6) ----
3072
+
3073
+ /**
3074
+ * Called with the percent completed (0..100) while a long-running method runs, when Chilkat
3075
+ * can measure progress. Runs on the JavaScript thread, so it is only useful with the
3076
+ * `...Async` methods (during a synchronous call the thread is busy and the events arrive
3077
+ * after it returns). Assign `undefined` to remove.
3078
+ */
3079
+ onPercentDone?: (pctDone: number) => void
3080
+
3081
+ /**
3082
+ * Called with a name/value pair of progress information while a long-running method runs
3083
+ * (what is reported depends on the class and method). Runs on the JavaScript thread; see
3084
+ * {@link Http.onPercentDone}. Assign `undefined` to remove.
3085
+ */
3086
+ onProgressInfo?: (name: string, value: string) => void
3087
+
3088
+ /**
3089
+ * Requests that the pending `...Async` call on this object stop at its next progress check.
3090
+ * The promise then rejects with Chilkat's abort error. Chilkat checks at least every
3091
+ * `heartbeatMs` milliseconds on the classes that have that property, so set it (e.g. 250)
3092
+ * for a responsive cancel. Harmless when nothing is pending.
3093
+ */
3094
+ abort(): void
3095
+ }