Inherits from NSObject
Declared in AlfrescoPersonService.h

Overview

The AlfrescoPersonService to obtain details about registered users.

Author: Gavin Cornwell (Alfresco), Tijs Rademakers (Alfresco), Peter Schmidt (Alfresco)

Tasks

Initialisation methods

Person Retrieval methods

Search Person methods

Instance Methods

initWithSession:

Initialises with a standard Cloud or OnPremise session

- (id)initWithSession:(id<AlfrescoSession>)session

Parameters

session

the AlfrescoSession to initialise the site service with.

Discussion

Initialises with a standard Cloud or OnPremise session

Declared In

AlfrescoPersonService.h

refreshPerson:completionBlock:

Retrieve the latest (and complete) properties for person.

- (AlfrescoRequest *)refreshPerson:(AlfrescoPerson *)person completionBlock:(AlfrescoPersonCompletionBlock)completionBlock

Parameters

completionBlock

The block that’s called with person’s complete properties.

The

person which is to be refreshed with its latest properties

Discussion

Retrieve the latest (and complete) properties for person.

Declared In

AlfrescoPersonService.h

retrieveAvatarForPerson:completionBlock:

Gets the person with given identifier

- (AlfrescoRequest *)retrieveAvatarForPerson:(AlfrescoPerson *)person completionBlock:(AlfrescoContentFileCompletionBlock)completionBlock

Parameters

person
completionBlock
  • contains the AlfrescoContentFile object with a pointer to the avatar image if successful, or nil if not.

Discussion

Gets the person with given identifier

Declared In

AlfrescoPersonService.h

retrievePersonWithIdentifier:completionBlock:

Gets the person with given identifier

- (AlfrescoRequest *)retrievePersonWithIdentifier:(NSString *)identifier completionBlock:(AlfrescoPersonCompletionBlock)completionBlock

Parameters

identifier
  • The person identifier to be looked up.
completionBlock

Discussion

Gets the person with given identifier

Declared In

AlfrescoPersonService.h

searchWithKeywords:completionBlock:

Returns a list of site members that respect the provided keywords.

- (AlfrescoRequest *)searchWithKeywords:(NSString *)keywords completionBlock:(AlfrescoArrayCompletionBlock)completionBlock

Parameters

keywords
  • space delimited list of keywords that needs to be applied to search query.
completionBlock
  • contains Array of person objects that respect the filter if successful, or nil if not.

Discussion

Returns a list of site members that respect the provided keywords.

Declared In

AlfrescoPersonService.h

searchWithKeywords:listingContext:completionBlock:

Returns a paged list of site members that respect the provided keywords.

- (AlfrescoRequest *)searchWithKeywords:(NSString *)keywords listingContext:(AlfrescoListingContext *)listingContext completionBlock:(AlfrescoPagingResultCompletionBlock)completionBlock

Parameters

keywords
  • space delimited list of keywords that needs to be applied to search query.
listingContext
  • The listing context with a paging definition that’s used to search for people.
completionBlock
  • contains Array of person objects that respect the filter if successful, or nil if not.

Discussion

Returns a paged list of site members that respect the provided keywords.

Declared In

AlfrescoPersonService.h