EasyDevCoreV4.Remote.xml 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>EasyDevCoreV4.Remote</name>
  5. </assembly>
  6. <members>
  7. <member name="T:EasyDevCore.Remote.HttpAccess.FileContent">
  8. <summary>
  9. Represents HTTP content based on a local file. Typically used with PostMultipartAsync for uploading files.
  10. </summary>
  11. </member>
  12. <member name="P:EasyDevCore.Remote.HttpAccess.FileContent.Path">
  13. <summary>
  14. The local file path.
  15. </summary>
  16. </member>
  17. <member name="M:EasyDevCore.Remote.HttpAccess.FileContent.#ctor(System.String,System.Int32)">
  18. <summary>
  19. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.HttpAccess.FileContent" /> class.
  20. </summary>
  21. <param name="path">The local file path.</param>
  22. <param name="bufferSize">The buffer size of the stream upload in bytes. Defaults to 4096.</param>
  23. </member>
  24. <member name="M:EasyDevCore.Remote.HttpAccess.FileContent.SerializeToStreamAsync(System.IO.Stream,System.Net.TransportContext)">
  25. <summary>
  26. Serializes to stream asynchronous.
  27. </summary>
  28. <param name="stream">The stream.</param>
  29. <param name="context">The context.</param>
  30. <returns></returns>
  31. </member>
  32. <member name="M:EasyDevCore.Remote.HttpAccess.FileContent.TryComputeLength(System.Int64@)">
  33. <summary>
  34. Tries the length of the compute.
  35. </summary>
  36. <param name="length">The length.</param>
  37. <returns></returns>
  38. </member>
  39. <member name="T:EasyDevCore.Remote.HttpAccess.ISerializer">
  40. <summary>
  41. Contract for serializing and deserializing objects.
  42. </summary>
  43. </member>
  44. <member name="M:EasyDevCore.Remote.HttpAccess.ISerializer.Serialize(System.Object)">
  45. <summary>
  46. Serializes an object to a string representation.
  47. </summary>
  48. </member>
  49. <member name="M:EasyDevCore.Remote.HttpAccess.ISerializer.Serialize``1(``0)">
  50. <summary>
  51. Serializes the specified object.
  52. </summary>
  53. <typeparam name="T"></typeparam>
  54. <param name="obj">The object.</param>
  55. <returns></returns>
  56. </member>
  57. <member name="M:EasyDevCore.Remote.HttpAccess.ISerializer.Deserialize``1(System.String)">
  58. <summary>
  59. Deserializes an object from a string representation.
  60. </summary>
  61. </member>
  62. <member name="M:EasyDevCore.Remote.HttpAccess.ISerializer.Deserialize``1(System.IO.Stream)">
  63. <summary>
  64. Deserializes an object from a stream representation.
  65. </summary>
  66. </member>
  67. <member name="M:EasyDevCore.Remote.HttpAccess.ISerializer.DeserializeAsync``1(System.IO.Stream)">
  68. <summary>
  69. Deserializes the asynchronous.
  70. </summary>
  71. <typeparam name="T"></typeparam>
  72. <param name="stream">The stream.</param>
  73. <returns></returns>
  74. </member>
  75. <member name="T:EasyDevCore.Remote.HttpAccess.HttpAccessSetup">
  76. <summary>
  77. </summary>
  78. </member>
  79. <member name="P:EasyDevCore.Remote.HttpAccess.HttpAccessSetup.JsonSerializerRequest">
  80. <summary>
  81. Gets or sets the json serializer request.
  82. </summary>
  83. <value>
  84. The json serializer request.
  85. </value>
  86. </member>
  87. <member name="P:EasyDevCore.Remote.HttpAccess.HttpAccessSetup.UrlEncodedSerializerRequest">
  88. <summary>
  89. Gets or sets the URL encoded serializer.
  90. </summary>
  91. <value>
  92. The URL encoded serializer.
  93. </value>
  94. </member>
  95. <member name="P:EasyDevCore.Remote.HttpAccess.HttpAccessSetup.JsonSerializerResponse">
  96. <summary>
  97. Gets or sets the json serializer response.
  98. </summary>
  99. <value>
  100. The json serializer response.
  101. </value>
  102. </member>
  103. <member name="T:EasyDevCore.Remote.HttpAccess.HttpClientRequestExtensions">
  104. <summary>
  105. </summary>
  106. </member>
  107. <member name="M:EasyDevCore.Remote.HttpAccess.HttpClientRequestExtensions.BaseUrl(System.Net.Http.HttpClient,System.String)">
  108. <summary>
  109. set the base URL.
  110. </summary>
  111. <param name="httpClient">The HTTP client.</param>
  112. <param name="baseUrl">The base URL.</param>
  113. <returns></returns>
  114. </member>
  115. <member name="M:EasyDevCore.Remote.HttpAccess.HttpClientRequestExtensions.PostAsParamAsync``1(System.Net.Http.HttpClient,System.String,``0,System.Threading.CancellationToken)">
  116. <summary>
  117. Posts as parameter asynchronous.
  118. </summary>
  119. <typeparam name="T"></typeparam>
  120. <param name="httpClient">The HTTP client.</param>
  121. <param name="url">The URL.</param>
  122. <param name="data">The data.</param>
  123. <param name="cancellationToken">The cancellation token.</param>
  124. <returns></returns>
  125. </member>
  126. <member name="M:EasyDevCore.Remote.HttpAccess.HttpClientRequestExtensions.GetAsync``1(System.Net.Http.HttpClient,System.String,``0,System.Threading.CancellationToken)">
  127. <summary>
  128. Gets the asynchronous.
  129. </summary>
  130. <typeparam name="T"></typeparam>
  131. <param name="httpClient">The HTTP client.</param>
  132. <param name="url">The URL.</param>
  133. <param name="data">The data.</param>
  134. <param name="cancellationToken">The cancellation token.</param>
  135. <returns></returns>
  136. </member>
  137. <member name="M:EasyDevCore.Remote.HttpAccess.HttpClientRequestExtensions.ToInvariantString(System.Object)">
  138. <summary>
  139. Returns a string that represents the current object, using CultureInfo.InvariantCulture where possible.
  140. Dates are represented in IS0 8601.
  141. </summary>
  142. </member>
  143. <member name="T:EasyDevCore.Remote.HttpAccess.HttpClientResponseExtensions">
  144. <summary>
  145. </summary>
  146. </member>
  147. <member name="M:EasyDevCore.Remote.HttpAccess.HttpClientResponseExtensions.GetJsonAsync``1(System.Threading.Tasks.Task{System.Net.Http.HttpResponseMessage},``0)">
  148. <summary>
  149. Gets the json asynchronous.
  150. </summary>
  151. <typeparam name="TResult">The type of the result.</typeparam>
  152. <param name="response">The response.</param>
  153. <param name="defaultValue">The default value.</param>
  154. <returns></returns>
  155. </member>
  156. <member name="M:EasyDevCore.Remote.HttpAccess.HttpClientResponseExtensions.MakeResultAsync``1(System.Threading.Tasks.Task{System.Net.Http.HttpResponseMessage},System.Func{System.Exception,``0})">
  157. <summary>
  158. Makes the result.
  159. </summary>
  160. <typeparam name="TResult">The type of the result.</typeparam>
  161. <param name="response">The response.</param>
  162. <param name="failure">The failure.</param>
  163. <returns></returns>
  164. </member>
  165. <member name="T:EasyDevCore.Remote.HttpAccess.TextJsonSerializer">
  166. <summary>
  167. ISerializer implementation that uses System.Text.Json
  168. Default serializer used in calls to GetJson, etc.
  169. </summary>
  170. </member>
  171. <member name="M:EasyDevCore.Remote.HttpAccess.TextJsonSerializer.#ctor">
  172. <summary>
  173. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.HttpAccess.TextJsonSerializer"/> class.
  174. </summary>
  175. </member>
  176. <member name="M:EasyDevCore.Remote.HttpAccess.TextJsonSerializer.#ctor(System.Text.Json.JsonSerializerOptions)">
  177. <summary>
  178. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.HttpAccess.TextJsonSerializer"/> class.
  179. </summary>
  180. <param name="options">The options.</param>
  181. </member>
  182. <member name="M:EasyDevCore.Remote.HttpAccess.TextJsonSerializer.Serialize(System.Object)">
  183. <summary>
  184. Serializes the specified object.
  185. </summary>
  186. <param name="obj">The object.</param>
  187. <returns></returns>
  188. </member>
  189. <member name="M:EasyDevCore.Remote.HttpAccess.TextJsonSerializer.Serialize``1(``0)">
  190. <summary>
  191. Serializes the specified object.
  192. </summary>
  193. <typeparam name="T"></typeparam>
  194. <param name="obj">The object.</param>
  195. <returns></returns>
  196. </member>
  197. <member name="M:EasyDevCore.Remote.HttpAccess.TextJsonSerializer.Deserialize``1(System.String)">
  198. <summary>
  199. Deserializes the specified s.
  200. </summary>
  201. <typeparam name="T"></typeparam>
  202. <param name="s">The s.</param>
  203. <returns></returns>
  204. </member>
  205. <member name="M:EasyDevCore.Remote.HttpAccess.TextJsonSerializer.Deserialize``1(System.IO.Stream)">
  206. <summary>
  207. Deserializes the specified stream.
  208. </summary>
  209. <typeparam name="T"></typeparam>
  210. <param name="stream">The stream.</param>
  211. <returns></returns>
  212. </member>
  213. <member name="M:EasyDevCore.Remote.HttpAccess.TextJsonSerializer.DeserializeAsync``1(System.IO.Stream)">
  214. <summary>
  215. Deserializes the asynchronous.
  216. </summary>
  217. <typeparam name="T"></typeparam>
  218. <param name="stream">The stream.</param>
  219. <returns></returns>
  220. </member>
  221. <member name="T:EasyDevCore.Remote.HttpAccess.UrlEncodedSerializer">
  222. <summary>
  223. ISerializer implementation that converts an object representing name/value pairs to a URL-encoded string.
  224. Default serializer used in calls to PostUrlEncodedAsync, etc.
  225. </summary>
  226. </member>
  227. <member name="M:EasyDevCore.Remote.HttpAccess.UrlEncodedSerializer.Serialize(System.Object)">
  228. <summary>
  229. Serializes the specified object.
  230. </summary>
  231. <param name="obj">The object.</param>
  232. </member>
  233. <member name="M:EasyDevCore.Remote.HttpAccess.UrlEncodedSerializer.Serialize``1(``0)">
  234. <summary>
  235. Serializes the specified object.
  236. </summary>
  237. <typeparam name="T"></typeparam>
  238. <param name="obj">The object.</param>
  239. <returns></returns>
  240. </member>
  241. <member name="M:EasyDevCore.Remote.HttpAccess.UrlEncodedSerializer.Deserialize``1(System.String)">
  242. <summary>
  243. Deserializes the specified s.
  244. </summary>
  245. <typeparam name="T"></typeparam>
  246. <param name="s">The s.</param>
  247. <exception cref="T:System.NotImplementedException">Deserializing to UrlEncoded not supported.</exception>
  248. </member>
  249. <member name="M:EasyDevCore.Remote.HttpAccess.UrlEncodedSerializer.Deserialize``1(System.IO.Stream)">
  250. <summary>
  251. Deserializes the specified stream.
  252. </summary>
  253. <typeparam name="T"></typeparam>
  254. <param name="stream">The stream.</param>
  255. <exception cref="T:System.NotImplementedException">Deserializing to UrlEncoded not supported.</exception>
  256. </member>
  257. <member name="M:EasyDevCore.Remote.HttpAccess.UrlEncodedSerializer.DeserializeAsync``1(System.IO.Stream)">
  258. <summary>
  259. Deserializes the asynchronous.
  260. </summary>
  261. <typeparam name="T"></typeparam>
  262. <param name="stream">The stream.</param>
  263. <returns></returns>
  264. <exception cref="T:System.NotImplementedException"></exception>
  265. </member>
  266. <member name="T:EasyDevCore.Remote.ResultMode">
  267. <summary>
  268. Enum ResultMode
  269. </summary>
  270. </member>
  271. <member name="F:EasyDevCore.Remote.ResultMode.Success">
  272. <summary>
  273. The success
  274. </summary>
  275. </member>
  276. <member name="F:EasyDevCore.Remote.ResultMode.Failed">
  277. <summary>
  278. The failed
  279. </summary>
  280. </member>
  281. <member name="F:EasyDevCore.Remote.ResultMode.Info">
  282. <summary>
  283. The information
  284. </summary>
  285. </member>
  286. <member name="F:EasyDevCore.Remote.ResultMode.Warning">
  287. <summary>
  288. The warning
  289. </summary>
  290. </member>
  291. <member name="F:EasyDevCore.Remote.ResultMode.Confirmation">
  292. <summary>
  293. The Confirmation
  294. </summary>
  295. </member>
  296. <member name="F:EasyDevCore.Remote.ResultMode.Error">
  297. <summary>
  298. The error
  299. </summary>
  300. </member>
  301. <member name="T:EasyDevCore.Remote.IResult">
  302. <summary>
  303. </summary>
  304. </member>
  305. <member name="P:EasyDevCore.Remote.IResult.IsError">
  306. <summary>
  307. Gets a value indicating whether this instance is error.
  308. </summary>
  309. <value>
  310. <c>true</c> if this instance is error; otherwise, <c>false</c>.
  311. </value>
  312. </member>
  313. <member name="P:EasyDevCore.Remote.IResult.IsSucceeded">
  314. <summary>
  315. Gets a value indicating whether this instance is succeeded.
  316. </summary>
  317. <value>
  318. <c>true</c> if this instance is succeeded; otherwise, <c>false</c>.
  319. </value>
  320. </member>
  321. <member name="P:EasyDevCore.Remote.IResult.Message">
  322. <summary>
  323. Gets or sets the message.
  324. </summary>
  325. <value>
  326. The message.
  327. </value>
  328. </member>
  329. <member name="P:EasyDevCore.Remote.IResult.ResultCode">
  330. <summary>
  331. Gets or sets the result code.
  332. </summary>
  333. <value>
  334. The result code.
  335. </value>
  336. </member>
  337. <member name="P:EasyDevCore.Remote.IResult.ResultStatus">
  338. <summary>
  339. Gets or sets the result status.
  340. </summary>
  341. <value>
  342. The result status.
  343. </value>
  344. </member>
  345. <member name="T:EasyDevCore.Remote.IResult`1">
  346. <summary>
  347. </summary>
  348. <typeparam name="TData">The type of the data.</typeparam>
  349. </member>
  350. <member name="P:EasyDevCore.Remote.IResult`1.Data">
  351. <summary>
  352. Gets or sets the data.
  353. </summary>
  354. <value>
  355. The data.
  356. </value>
  357. </member>
  358. <member name="M:EasyDevCore.Remote.IResult`1.Map``1(System.Func{`0,``0})">
  359. <summary>
  360. Maps the specified convert.
  361. </summary>
  362. <typeparam name="TMapData">The type of the map data.</typeparam>
  363. <param name="convert">The convert.</param>
  364. <returns></returns>
  365. </member>
  366. <member name="T:EasyDevCore.Remote.Result">
  367. <summary>
  368. </summary>
  369. <seealso cref="T:EasyDevCore.Remote.IResult" />
  370. </member>
  371. <member name="P:EasyDevCore.Remote.Result.ResultStatus">
  372. <summary>
  373. Gets or sets the result status.
  374. </summary>
  375. <value>
  376. The result status.
  377. </value>
  378. </member>
  379. <member name="P:EasyDevCore.Remote.Result.ResultCode">
  380. <summary>
  381. Gets or sets the result code.
  382. </summary>
  383. <value>
  384. The result code.
  385. </value>
  386. </member>
  387. <member name="P:EasyDevCore.Remote.Result.Message">
  388. <summary>
  389. Gets or sets the message.
  390. </summary>
  391. <value>
  392. The message.
  393. </value>
  394. </member>
  395. <member name="P:EasyDevCore.Remote.Result.IsSucceeded">
  396. <summary>
  397. Gets a value indicating whether this instance is succeeded.
  398. </summary>
  399. <value>
  400. <c>true</c> if this instance is succeeded; otherwise, <c>false</c>.
  401. </value>
  402. </member>
  403. <member name="P:EasyDevCore.Remote.Result.Error">
  404. <summary>
  405. Gets or sets the error.
  406. </summary>
  407. <value>
  408. The error.
  409. </value>
  410. </member>
  411. <member name="P:EasyDevCore.Remote.Result.IsError">
  412. <summary>
  413. Gets a value indicating whether this instance is error.
  414. </summary>
  415. <value>
  416. <c>true</c> if this instance is error; otherwise, <c>false</c>.
  417. </value>
  418. </member>
  419. <member name="P:EasyDevCore.Remote.Result.HttpResultStatus">
  420. <summary>
  421. Gets or sets the HTTP result status.
  422. </summary>
  423. <value>
  424. The HTTP result status.
  425. </value>
  426. </member>
  427. <member name="M:EasyDevCore.Remote.Result.#ctor">
  428. <summary>
  429. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.Result`1"/> class.
  430. </summary>
  431. </member>
  432. <member name="M:EasyDevCore.Remote.Result.#ctor(System.Exception)">
  433. <summary>
  434. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.Result`1" /> class.
  435. </summary>
  436. <param name="error">The error.</param>
  437. </member>
  438. <member name="M:EasyDevCore.Remote.Result.#ctor(EasyDevCore.Remote.ResultMode,System.String,System.String)">
  439. <summary>
  440. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.Result`1" /> class.
  441. </summary>
  442. <param name="resultStatus">The result status.</param>
  443. <param name="resultCode">The result code.</param>
  444. <param name="message">The message.</param>
  445. </member>
  446. <member name="T:EasyDevCore.Remote.Result`1">
  447. <summary>
  448. </summary>
  449. <typeparam name="TData">The type of the value.</typeparam>
  450. </member>
  451. <member name="P:EasyDevCore.Remote.Result`1.Data">
  452. <summary>
  453. Gets or sets the data.
  454. </summary>
  455. <value>
  456. The data.
  457. </value>
  458. </member>
  459. <member name="M:EasyDevCore.Remote.Result`1.#ctor">
  460. <summary>
  461. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.Result`1"/> class.
  462. </summary>
  463. </member>
  464. <member name="M:EasyDevCore.Remote.Result`1.#ctor(System.Exception)">
  465. <summary>
  466. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.Result`1" /> class.
  467. </summary>
  468. <param name="error">The error.</param>
  469. </member>
  470. <member name="M:EasyDevCore.Remote.Result`1.#ctor(`0,EasyDevCore.Remote.ResultMode,System.String,System.String)">
  471. <summary>
  472. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.Result`1"/> class.
  473. </summary>
  474. <param name="data">The data.</param>
  475. <param name="resultStatus">The result status.</param>
  476. <param name="resultCode">The result code.</param>
  477. <param name="message">The message.</param>
  478. </member>
  479. <member name="M:EasyDevCore.Remote.Result`1.#ctor(`0,System.Exception)">
  480. <summary>
  481. Initializes a new instance of the <see cref="T:EasyDevCore.Remote.Result`1" /> class.
  482. </summary>
  483. <param name="data">The data.</param>
  484. <param name="error">The exception.</param>
  485. </member>
  486. <member name="M:EasyDevCore.Remote.Result`1.Map``1(System.Func{`0,``0})">
  487. <summary>
  488. Maps the specified convert.
  489. </summary>
  490. <typeparam name="TMapData">The type of the map data.</typeparam>
  491. <param name="convert">The convert.</param>
  492. <returns></returns>
  493. </member>
  494. <member name="T:JsonDateTimeConverter">
  495. <summary>
  496. </summary>
  497. </member>
  498. <member name="M:JsonDateTimeConverter.Read(System.Text.Json.Utf8JsonReader@,System.Type,System.Text.Json.JsonSerializerOptions)">
  499. <summary>
  500. Reads and converts the JSON to type.
  501. </summary>
  502. <param name="reader">The reader.</param>
  503. <param name="typeToConvert">The type to convert.</param>
  504. <param name="options">An object that specifies serialization options to use.</param>
  505. <returns>
  506. The converted value.
  507. </returns>
  508. <exception cref="T:System.Text.Json.JsonException">
  509. Unexpected token type: {reader.TokenType}
  510. or
  511. Unable to convert '{dateTimeString}' to DateTime
  512. </exception>
  513. </member>
  514. <member name="M:JsonDateTimeConverter.Write(System.Text.Json.Utf8JsonWriter,System.DateTime,System.Text.Json.JsonSerializerOptions)">
  515. <summary>
  516. Writes a specified value as JSON.
  517. </summary>
  518. <param name="writer">The writer to write to.</param>
  519. <param name="value">The value to convert to JSON.</param>
  520. <param name="options">An object that specifies serialization options to use.</param>
  521. </member>
  522. <member name="M:JsonDateTimeConverter.CanConvert(System.Type)">
  523. <summary>
  524. Determines whether the specified type can be converted.
  525. </summary>
  526. <param name="typeToConvert">The type to compare against.</param>
  527. <returns>
  528. <see langword="true" /> if the type can be converted; otherwise, <see langword="false" />.
  529. </returns>
  530. </member>
  531. </members>
  532. </doc>