SkyVaultSiteService
This section describes the SkyVaultSiteService class.
The SkyVaultSiteService class provides methods to retrieve sites from an SkyVault repository.
Class declaration
@interface SkyVaultSiteService : SkyVaultBaseService
Constants
Apps require the ability to filter sites by visibility, to enable this the filter constants defined below have been added.
| Constant |
|---|
| extern NSString * const kAlfrescoFilterBySiteVisibility; |
| extern NSString * const kAlfrescoFilterValueSiteVisibilityPublic; |
| extern NSString * const kAlfrescoFilterValueSiteVisibilityModerated; |
| extern NSString * const kAlfrescoFilterValueSiteVisibilityPrivate; |
- isPerson:MemberOfSite- (AlfrescoRequest *)isPerson:(AlfrescoPerson *)person memberOfSite:(AlfrescoSite *)site completionBlock:(AlfrescoMemberCompletionBlock)completionBlock - determines if a person is a member of the specified site.
- addFavoriteSite-(AlfrescoRequest *) addFavoriteSite:(AlfrescoSite *)site completionBlock:(AlfrescoSiteCompletionBlock)completionBlock - adds the given site to the current user's list of favorite sites, if the request cannot be completed successfully an error with code 403 is returned.
- removeFavoriteSite-(AlfrescoRequest *) removeFavoriteSite:(AlfrescoSite *)site completionBlock:(AlfrescoSiteCompletionBlock)completionBlock - removes the given site from the current user's list of favorite sites, if the request cannot be completed successfully an error with code 404 is returned.
- joinSite-(AlfrescoRequest *) joinSite:(AlfrescoSite *)site completionBlock:(AlfrescoSiteCompletionBlock)completionBlock - Adds the current user as a member of the given site.
- retrievePendingSitesWithCompletionBlock-(AlfrescoRequest *) retrievePendingSitesWithCompletionBlock:(AlfrescoSite *)site completionBlock:(AlfrescoArrayCompletionBlock)completionBlock - Retrieves a list of sites the current user has requested to join. An empty array is returned if there are no outstanding requests.
- cancelRequestToJoinSite-(AlfrescoRequest *) cancelRequestToJoinSite:(AlfrescoSite *)site completionBlock:(AlfrescoSiteCompletionBlock)completionBlock - Cancels a previous request to join a site made by the current user. If the request cannot be completed successfully an error with code 407 is returned.
- leaveSite-(AlfrescoRequest *) leaveSite:(AlfrescoSite *)site completionBlock:(AlfrescoSiteCompletionBlock)completionBlock - Removes the current user from the given site. If the request cannot be completed successfully an error with code 408 is returned.
- retrieveSiteWithShortName:completionBlock-(AlfrescoRequest *) retrieveSiteWithShortName:(NSString *)siteShortName completionBlock:(AlfrescoSiteCompletionBlock)completionBlock - retrieves a site with the specified short name. If the site does not exist a null is returned.
- retrieveAllMembersOfSite:site:completionBlock- (AlfrescoRequest *)retrieveAllMembersOfSite:(AlfrescoSite *)site completionBlock:(AlfrescoArrayCompletionBlock)completionBlock - Returns a list of all members for a site.
- retrieveAllMembersOfSite:site:listingContext:completionBlock- (AlfrescoRequest *)retrieveAllMembersOfSite:(AlfrescoSite *)site listingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock - Returns a paged list of all members for a site.
- searchMembersOfSite:site:keywords:listingContext:completionBlock- (AlfrescoRequest *)searchMembersOfSite:(AlfrescoSite *)site keywords:(NSString *)keywords listingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock - Returns a paged list of members of a site that match the provided keywords.
- retrieveAllSitesWithCompletionBlock-(AlfrescoRequest *) retrieveAllSitesWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock - retrieves a list of sites in the repository that the current user has visibility of.
- retrieveAllSitesWithListingContext:completionBlock-(AlfrescoRequest *) retrieveAllSitesWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock - retrieves a paged list of all sites in the repository that the current user has visibility of.
- retrieveSitesWithCompletionBlock-(AlfrescoRequest *) retrieveSitesWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock - retrieves a list of sites in the repository that the current user has explicit membership of.
- retrieveSitesWithListingContext:completionBlock-(AlfrescoRequest *) retrieveSitesWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock - retrieves a paged list of all sites in the repository that the current user has explicit membership of.
- retrieveFavoriteSitesWithCompletionBlock-(AlfrescoRequest *) retrieveFavoriteSitesWithCompletionBlock:(AlfrescoArrayCompletionBlock)completionBlock - retrieves a list of sites in the repository that the current user has explicit membership of and which have been marked as a favorite.
- retrieveFavoriteSitesWithListingContext:completionBlock-(AlfrescoRequest *) retrieveFavoriteSitesWithListingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock - retrieves a paged list of all sites in the repository that the current user has explicit membership of and which have been marked as a favorite.
- retrieveDocumentLibraryFolderForSite:completionBlock-(AlfrescoRequest *) retrieveDocumentLibraryFolderForSite:(AlfrescoSite *)site completionBlock:(AlfrescoFolderCompletionBlock)completionBlock - retrieves the document library folder for the specified site.
Parent topic: Services