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