Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add documentation for 5.7.0 version #937

Merged
merged 3 commits into from
Feb 27, 2024
Merged

docs: add documentation for 5.7.0 version #937

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ed3945
docs: add docs for marker-based `GetFolderItems`
mwwoda Jan 24, 2024
e3661f4
Merge branch 'main' into docs-for-570
mwwoda Feb 26, 2024
a4eecd9
Merge branch 'main' into docs-for-570
arjankowski Feb 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions docs/folders.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,20 @@ Get a Folder's Items
--------------------

Folder items can be retrieved by calling the
`FoldersManager.GetFolderItemsAsync(string id, int limit, int offset = 0, IEnumerable<string> fields = null, bool autoPaginate=false)`
`FoldersManager.GetFolderItemsMarkerBasedAsync(string id, int limit string marker = null, IEnumerable<string> fields = null, bool autoPaginate = false, string sort = null, BoxSortDirection? direction = null, string sharedLink = null, string sharedLinkPassword = null)`
method. Use the `fields` option to specify the desired fields.
Requesting information for only the fields you need can improve performance by reducing the size of the network response.
Following method supports marker-based pagination.

<!-- sample get_folders_id_items -->
```c#
BoxCollection<BoxItem> folderItems = await client.FoldersManager.GetFolderItemsAsync("11111", 100);
BoxCollection<BoxItem> folderItems = await client.FoldersManager.GetFolderItemsMarkerBasedAsync("11111", 100);
```

Alternatively you can use method with offset-based pagination.

```c#
BoxCollection<BoxItem> folderItems = await client.FoldersManager.GetFolderItemsAsync("11111", 100, offset: 10);
```

Get a Folder's Information
Expand Down
Loading