getFavoriteDocuments returns a list of the current user's
favorite documents.
Attention: This method was added in SDK version
1.2.
public List<Document> getFavoriteDocuments()
public List<Document> getFavoriteDocuments() returns
a list of the current user's favorite documents.
Parameters
None
Returns
Returns a List<Document> of the current user's favorite documents.
Exception
Throws an SkyVaultServiceException if the operation cannot be completed.
Example
// get favorite documents
for (Document document : documentFolderService
.getFavoriteDocuments()) {
if (!document.hasAllProperties()) {
// if hasAllProperties() returns false then refresh
// Node
document = (Document) documentFolderService.refreshNode(document);
}
Log.d(TAG, "title: " + document.getTitle());
Log.d(TAG, "description: " + document.getDescription());
Log.d(TAG, "name: " + document.getName());
Log.d(TAG, "isDocument: " + document.isDocument());
}
public PagingResult<Document> getFavoriteDocuments(ListingContext listingContext)
public PagingResult<Document>
getFavoriteDocuments(ListingContext listingContext) returns a paged list of the
current user's favorite documents.
Parameters
- ListingContext listingContext
- The listing context to use to control paging of results. See ListingContext for further information.
Returns
Returns a PagingResult<Document> object representing a collection of the current user's favorite documents.
Exception
Throws an SkyVaultServiceException if the operation cannot be completed.
Example