From ba5fe170c6047fb9bf8feb0b0edc9fb2a77a3ae6 Mon Sep 17 00:00:00 2001 From: Bruce Tian Date: Sun, 22 Oct 2023 11:59:12 +0800 Subject: [PATCH] doc: patch request --- docs/doc_eng.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/docs/doc_eng.md b/docs/doc_eng.md index a8d7621..afda58a 100755 --- a/docs/doc_eng.md +++ b/docs/doc_eng.md @@ -208,6 +208,62 @@ Task TusHeadAsync(TusHeadRequestOption reqOption, CancellationT + + +#### TusPatchAsync + +##### Definition + +resume upload file + +```c# +Task TusPatchAsync(TusPatchRequestOption reqOption, CancellationToken ct = default) +``` + + + +##### Type Parameters + + + +###### TusPatchRequestOption + +[Derived TusRequestOptionBase](#TusRequestOptionBase) + +| Name | Type | Definition | +| ---------------- | -------------------------------- | ------------------------------------------------------------ | +| Stream | Stream | file stream | +| FileLocation | Uri | file uri | +| UploadBufferSize | uint | uploadSize ,default value 1MB | +| UploadType | UploadType | setting upload file with chunk or stream, default value is Stream | +| OnProgressAsync | Func? | invoke when uploading file | +| OnFailedAsync | Func? | invoke when appear a Exception | +| OnCompletedAsync | Func? | invoke when complete uploading | + + + +##### Returns + +###### TusPatchResponse + +[Derived TusResponseBase](#TusResponseBase) + +| Name | Type | Definition | +| ------------ | ---- | ----------------------------------- | +| UploadedSize | Long | indicate the size of uploaded bytes | + + + + + + + + + + + + + ---