From 4f1f70aaed9868ed3fe6d5db901fa69c7dee8372 Mon Sep 17 00:00:00 2001 From: Mateusz Woda Date: Tue, 14 Dec 2021 07:47:24 -0800 Subject: [PATCH] docs: docs update after release (#778) --- docs/file-request.md | 74 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 docs/file-request.md diff --git a/docs/file-request.md b/docs/file-request.md new file mode 100644 index 000000000..d6371f487 --- /dev/null +++ b/docs/file-request.md @@ -0,0 +1,74 @@ +File Requests +============= + +File request objects represent a file request associated with a folder. + + + + +- [Get a File Request's Information](#get-a-file-requests-information) +- [Copy a File Request's Information](#copy-a-file-requests-information) +- [Update a File Request's Information](#update-a-file-requests-information) +- [Delete a File Request](#delete-a-file-request) + + + +Get a File Request's Information +------------------------ + +Calling `FileRequestsManager.GetFileRequestByIdAsync(string fileRequestId)`returns information on a file request. + + +```c# +BoxFileRequestObject fileRequest = await client.FileRequestsManager.GetFileRequestByIdAsync("12345"); +``` + +Copy a File Request's Information +--------------------------- + +Calling `FileRequestsManager.CopyFileRequestAsync(string fileRequestId, BoxFileRequestCopyRequest copyRequest)` copies an existing file request that is already present +on one folder, and applies it to another folder. + + +```c# +var destinationFolder = new BoxRequestEntity +{ + Id = "123456", + Type = BoxType.folder +}; + +var copyRequest = new BoxFileRequestCopyRequest +{ + Description = "New file request description", + Folder = destinationFolder +}; + +BoxFileRequestObject fileRequest = await client.FileRequestsManager.CopyFileRequestAsync("12345", copyRequest); +``` + +Update a File Request's Information +--------------------------- + +Calling `FileRequestsManager.UpdateFileRequestAsync(string fileRequestId, BoxFileRequestUpdateRequest updateRequest)` updates a file request. This can be used to activate +or deactivate a file request. + + +```c# +var updateRequest = new BoxFileRequestUpdateRequest +{ + Description = "New file request description", + Status = BoxFileRequestStatus.inactive +}; + +BoxFileRequestObject fileRequest = await client.FileRequestsManager.UpdateFileRequestAsync("12345", updateRequest); +``` + +Delete a File Request +------------- + +Calling `FileRequestsManager.DeleteFileRequestAsync(string fileRequestId)` deletes a file request permanently. + + +```c# +bool isSuccess = await client.FileRequestsManager.DeleteFileRequestAsync("12345"); +``` \ No newline at end of file