You are here

getFavoriteSites

getFavoriteSites list the sites the current user has marked as a favorite.

public List<Site> getFavoriteSites()

public List<Site> getFavoriteSites() list the sites the current user has marked as a favorite.

Parameters

None

Returns

Returns a List<Site> representing a list of sites the current user has marked as favorites.

Exception

Throws an SkyVaultServiceException if the operation cannot be carried out.

Example


  // get favorite sites                   	
  List<Site> faves = siteService.getFavoriteSites();
  for (Site f : faves){
    Log.d(TAG, "Favorite: "+f.getShortName());
  }
          
        

public PagingResult<Site> getFavoriteSites(ListingContext listingContext)

public List<Site> getFavoriteSites(ListingContext listingContext) list with paging sites the current user has marked as a favorite.

Parameters

ListingContext listingContext
The listing context to use to control paging of results. See ListingContext for further information.

Returns

Returns a PagingResult<Site> representing a paged collection of sites the current user has marked as favorites.

Exception

Throws an SkyVaultServiceException if the operation cannot be carried out.

Example