You are here

getAllSites

getAllSites list the available sites, with paging if required.

public List<Site> getAllSites()

public List<Site> getAllSites() list the available sites.

Parameters

None

Returns

Returns a List<Site> representing a list of found sites.

Exception

Throws an SkyVaultServiceException if the operation cannot be carried out.

Example


  // connect to on-premise repo
  session = RepositorySession.connect(url,
          username, password);
  
  // Get site service
  siteService = session.getServiceRegistry()
          .getSiteService();

  // Get all sites
  List<Site> sites = siteService.getAllSites();

        

public PagingResult<Site> getAllSites(ListingContext listingContext)

public PagingResult<Site> getAllSites(ListingContext listingContext) list the available sites with paged results.

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 collection of found sites.

Exception

Throws an SkyVaultServiceException if the operation cannot be carried out.

Example