Skip to content

Commit

Permalink
docs: add docs for marker-based GetFolderItems
Browse files Browse the repository at this point in the history
  • Loading branch information
mwwoda committed Jan 24, 2024
1 parent 3015ce5 commit 0ed3945
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions docs/folders.md
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

0 comments on commit 0ed3945

Please sign in to comment.