Skip to content

Latest commit

 

History

History
106 lines (66 loc) · 2.58 KB

Collections.md

File metadata and controls

106 lines (66 loc) · 2.58 KB

ICollectionsManager

List all collections

Retrieves all collections for a given user.

Currently, only the favorites collection is supported.

This operation is performed by calling function GetCollections.

See the endpoint docs at API Reference.

await client.Collections.GetCollectionsAsync();

Arguments

  • queryParams GetCollectionsQueryParams
    • Query parameters of getCollections method
  • headers GetCollectionsHeaders
    • Headers of getCollections method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type Collections.

Returns all collections for the given user

List collection items

Retrieves the files and/or folders contained within this collection.

This operation is performed by calling function GetCollectionItems.

See the endpoint docs at API Reference.

await client.Collections.GetCollectionItemsAsync(collectionId: NullableUtils.Unwrap(favouriteCollection.Id));

Arguments

  • collectionId string
    • The ID of the collection. Example: "926489"
  • queryParams GetCollectionItemsQueryParams
    • Query parameters of getCollectionItems method
  • headers GetCollectionItemsHeaders
    • Headers of getCollectionItems method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type ItemsOffsetPaginated.

Returns an array of items in the collection.

Get collection by ID

Retrieves a collection by its ID.

This operation is performed by calling function GetCollectionById.

See the endpoint docs at API Reference.

await client.Collections.GetCollectionByIdAsync(collectionId: NullableUtils.Unwrap(NullableUtils.Unwrap(collections.Entries)[0].Id));

Arguments

  • collectionId string
    • The ID of the collection. Example: "926489"
  • headers GetCollectionByIdHeaders
    • Headers of getCollectionById method
  • cancellationToken System.Threading.CancellationToken?
    • Token used for request cancellation.

Returns

This function returns a value of type Collection.

Returns an array of items in the collection.