com.box.androidsdk.content.requests

Interface BoxCacheableRequest<T extends BoxObject>

Type Parameters:

T - The results of the request

All Known Implementing Classes:

BoxRequestRecentItems.GetRecentItems, BoxRequestsBookmark.GetBookmarkComments, BoxRequestsBookmark.GetBookmarkInfo, BoxRequestsBookmark.GetTrashedBookmark, BoxRequestsCollections.GetCollectionItems, BoxRequestsCollections.GetCollections, BoxRequestsComment.GetCommentInfo, BoxRequestsEvent.GetEnterpriseEvents, BoxRequestsEvent.GetUserEvents, BoxRequestsFile.GetFileComments, BoxRequestsFile.GetFileInfo, BoxRequestsFile.GetFileVersions, BoxRequestsFile.GetTrashedFile, BoxRequestsFolder.GetCollaborations, BoxRequestsFolder.GetFolderInfo, BoxRequestsFolder.GetFolderItems, BoxRequestsFolder.GetFolderWithAllItems, BoxRequestsFolder.GetTrashedFolder, BoxRequestsFolder.GetTrashedItems, BoxRequestsMetadata.GetFileMetadata, BoxRequestsMetadata.GetMetadataTemplates, BoxRequestsMetadata.GetMetadataTemplateSchema, BoxRequestsSearch.Search, BoxRequestsShare.GetCollaborationInfo, BoxRequestsShare.GetPendingCollaborations, BoxRequestsShare.GetSharedLink, BoxRequestsUser.GetEnterpriseUsers, BoxRequestsUser.GetUserInfo

public interface BoxCacheableRequest<T extends BoxObject>

Interface that adds the ability for requests to retrieve data from the cache instead of over the network.

Method Summary

Modifier and Type	Method and Description
T	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxFutureTask<T>	toTaskForCachedResult() Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Method Detail

sendForCachedResult

T sendForCachedResult()
               throws BoxException

Sends the request to fetch results from cache synchronously.

Returns:

the cached results of the request

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig, or if there was another issue getting cached results.

toTaskForCachedResult

BoxFutureTask<T> toTaskForCachedResult()
                                throws BoxException

Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Returns:

a task that will fetch the results from the cache

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig.