You are here

getFavoriteNodes

getFavoriteNodes returns a list of the current user's favorite nodes.
Attention: This method was added in SDK version 1.2.

public List<Folder> getFavoriteNodes()

public List<Folder> getFavoriteNodes() returns a list of the current user's favorite nodes.

Parameters

None

Returns

Returns a List<Folder> representing a list of the current user's favorite nodes.

Exception

Throws an SkyVaultServiceException if the operation cannot be completed.

Example

        
  // get Favorite Nodes
  for (Node node : documentFolderService.getFavoriteNodes()) {
  	if (!node.hasAllProperties()) {
  		// if hasAllProperties() returns false then refresh
  		// Node
  		node = (Node) documentFolderService.refreshNode(node);
  	}
  	Log.d(TAG, "title: " + node.getTitle());
  	Log.d(TAG, "description: " + node.getDescription());
  	Log.d(TAG, "name: " + node.getName());
  	Log.d(TAG, "isFolder: " + node.isFolder());						
  	Log.d(TAG, "isDocument: " + node.isDocument());						
  }     
        
      

public PagingResult<Folder> getFavoriteNodes(ListingContext listingContext)

public PagingResult<Folder> getFavoriteNodes(ListingContext listingContext) returns a paged list of the current user's favorite nodes.

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 nodes.

Exception

Throws an SkyVaultServiceException if the operation cannot be completed.

Example