com.box.sdkgen.managers.collections

Class CollectionsManager

Object

CollectionsManager

public class CollectionsManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CollectionsManager.Builder

Field Summary

Fields

Modifier and Type	Field and Description
Authentication	auth
NetworkSession	networkSession

Constructor Summary

Constructors

Modifier	Constructor and Description
	CollectionsManager()
protected	CollectionsManager(CollectionsManager.Builder builder)

Method Summary

Modifier and Type	Method and Description
Authentication	getAuth()
Collection	getCollectionById(String collectionId) Retrieves a collection by its ID.
Collection	getCollectionById(String collectionId, GetCollectionByIdHeaders headers) Retrieves a collection by its ID.
ItemsOffsetPaginated	getCollectionItems(String collectionId) Retrieves the files and/or folders contained within this collection.
ItemsOffsetPaginated	getCollectionItems(String collectionId, GetCollectionItemsHeaders headers) Retrieves the files and/or folders contained within this collection.
ItemsOffsetPaginated	getCollectionItems(String collectionId, GetCollectionItemsQueryParams queryParams) Retrieves the files and/or folders contained within this collection.
ItemsOffsetPaginated	getCollectionItems(String collectionId, GetCollectionItemsQueryParams queryParams, GetCollectionItemsHeaders headers) Retrieves the files and/or folders contained within this collection.
Collections	getCollections() Retrieves all collections for a given user.
Collections	getCollections(GetCollectionsHeaders headers) Retrieves all collections for a given user.
Collections	getCollections(GetCollectionsQueryParams queryParams) Retrieves all collections for a given user.
Collections	getCollections(GetCollectionsQueryParams queryParams, GetCollectionsHeaders headers) Retrieves all collections for a given user.
NetworkSession	getNetworkSession()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

auth

public Authentication auth

networkSession

public NetworkSession networkSession

Constructor Detail

CollectionsManager

public CollectionsManager()

CollectionsManager

protected CollectionsManager(CollectionsManager.Builder builder)

Method Detail

getCollections

public Collections getCollections()

Retrieves all collections for a given user.

Currently, only the `favorites` collection is supported.

getCollections

public Collections getCollections(GetCollectionsQueryParams queryParams)

Retrieves all collections for a given user.

Currently, only the `favorites` collection is supported.

Parameters:

queryParams - Query parameters of getCollections method

getCollections

public Collections getCollections(GetCollectionsHeaders headers)

Retrieves all collections for a given user.

Currently, only the `favorites` collection is supported.

Parameters:

headers - Headers of getCollections method

getCollections

public Collections getCollections(GetCollectionsQueryParams queryParams,
                                  GetCollectionsHeaders headers)

Retrieves all collections for a given user.

Currently, only the `favorites` collection is supported.

Parameters:

queryParams - Query parameters of getCollections method

headers - Headers of getCollections method

getCollectionItems

public ItemsOffsetPaginated getCollectionItems(String collectionId)

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

Parameters:

collectionId - The ID of the collection. Example: "926489"

getCollectionItems

public ItemsOffsetPaginated getCollectionItems(String collectionId,
                                               GetCollectionItemsQueryParams queryParams)

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

Parameters:

collectionId - The ID of the collection. Example: "926489"

queryParams - Query parameters of getCollectionItems method

getCollectionItems

public ItemsOffsetPaginated getCollectionItems(String collectionId,
                                               GetCollectionItemsHeaders headers)

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

Parameters:

collectionId - The ID of the collection. Example: "926489"

headers - Headers of getCollectionItems method

getCollectionItems

public ItemsOffsetPaginated getCollectionItems(String collectionId,
                                               GetCollectionItemsQueryParams queryParams,
                                               GetCollectionItemsHeaders headers)

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

Parameters:

collectionId - The ID of the collection. Example: "926489"

queryParams - Query parameters of getCollectionItems method

headers - Headers of getCollectionItems method

getCollectionById

public Collection getCollectionById(String collectionId)

Retrieves a collection by its ID.

Parameters:

collectionId - The ID of the collection. Example: "926489"

getCollectionById

public Collection getCollectionById(String collectionId,
                                    GetCollectionByIdHeaders headers)

Retrieves a collection by its ID.

Parameters:

collectionId - The ID of the collection. Example: "926489"

headers - Headers of getCollectionById method

getAuth

public Authentication getAuth()

getNetworkSession

public NetworkSession getNetworkSession()