You are here

SkyVault Mobile SDK for Android » Client API » org.alfresco.mobile.android.api.services

SiteService

org.alfresco.mobile.android.api.services.SiteService

This section describes the SiteService interface.

Sites are a key concept within SkyVault Share for managing documents, wiki pages, blog posts, discussions, and other collaborative content relating to teams, projects, and communities of interest.

Class declaration

public interface SiteService extends Service

Inherits from Implements
Service None

Constants

Apps requires the ability to filter sites by visibility, to enable this the filter constants defined below have been added.

Constant
public static String FILTER_KEY_VISIBILTY;
public static int FILTER_VISIBILITY_PUBLIC;
public static int FILTER_VISIBILITY_MODERATED;
public static int FILTER_VISIBILITY_PRIVATE;
  • addFavoriteSitepublic Site addFavoriteSite(Site site) - Adds the given site to the current users list of favorite sites, if the request cannot be completed successfully an exception is thrown with error code 400.
  • cancelRequestToJoinSitepublic Site cancelRequestToJoinSite(Site site) - Cancels a previous request to join a site made by the current user. If the request is successful a new Site object is returned reflecting the changed state. If the request cannot be completed successfully an exception is thrown with error code 400.
  • getAllMembersgetAllMembers - list all site members.
  • getAllSitesgetAllSites list the available sites, with paging if required.
  • getDocumentLibrarypublic Folder getDocumentLibrary(Site site) returns the document library folder for the specified site.
  • getFavoriteSitesgetFavoriteSites list the sites the current user has marked as a favorite.
  • getPendingSitespublic List<Site> getPendingSites() - Returns a list of pending site join requests made by the current user. An empty list is returned if there are no outstanding requests.
  • getSitepublic Site getSite(String siteShortName) return the site object for the specified site.
  • getSitesgetSites list the sites the specified user has explicit membership of.
  • isMemberpublic boolean isMember(Site site, Person person) - returns true is the specified person is a member of the specified site.
  • joinSitepublic Site joinSite(Site site) - Adds the surrent user as a member of the specified site.
  • leaveSitepublic Site leaveSite(Site site) - Removes the current user from the given site. If the operation is successful a new Site object is returned reflecting the changed state. If the request can not be completed successfully an exception is thrown with error code 400.
  • removeFavoriteSitepublic Site removeFavoriteSite(Site site) - Removes the given site from the current user's list of favorite sites, if the request cannot be completed successfully an exception is thrown with error code 400.
  • searchMemberssearchMembers - search for members in the site using the specified keywords.
Parent topic: org.alfresco.mobile.android.api.services

© 2017 TBS-LLC. All Rights Reserved.