You are here

getPeople

The getPeople(...) methods get the collection of people stored in the repository.

getPeople(filter)

getPeople(filter) get the collection of people stored in the repository.

An optional filter query can be provided by which to filter the people collection. Space separates the query terms, for example "john bob" will find all users whose first or second names contain the strings "john" or "bob".

CAUTION:
This method is deprecated in version 4.0 and above.

Parameters

filter
This is a query string by which to filter the collection of people. If null then all people stored in the repository are returned.

Returns

Returns an array of NodeRefs.

Example

        
var user;
var nodes = people.getPeople(null);
for each(var node in nodes)
{ 
  logger.log(node); 
  user = utils.getNodeFromString(node); 
  logger.log(user.properties["cm:userName"] + " '" 
      + user.properties["cm:firstName"] + "' '" 
      + user.properties["cm:lastName"] + "'"); 
}         
        
      

getPeople(filter, maxResults)

getPeople(filter, maxResults) get the collection of people stored in the repository.

An optional filter query can be provided by which to filter the people collection. Space separates the query terms, for example "john bob" will find all users whose first or second names contain the strings "john" or "bob".

Parameters

filter
This is a query string by which to filter the collection of people. If null then all people stored in the repository are returned.
maxResults
The maximum number of results to return. Returns all results if this value is set to be less than or equal to zero.

Returns

Returns an array of NodeRefs.

Example

The following snippet would return all users whose first or last names contained the string "fred". The results are limited to a maximum of 10 results:

    model.users = people.getPeople("fred", 10);    
        

getPeople(filter, maxResults, sortBy, sortAsc)

getPeople(filter, maxResults, sortBy, sortAsc) get the collection of people stored in the repository.

An optional filter query can be provided by which to filter the people collection. Space separates the query terms, for example "john bob" will find all users whose first or second names contain the strings "john" or "bob". This method supports sorting by specifying sortBy and sortAsc parameters.

Parameters

filter
This is a query string by which to filter the collection of people. If null then all people stored in the repository are returned.
maxResults
The maximum number of results to return. Returns all results if this value is set to be less than or equal to zero.
sortBy
The field for sorting.
sortAsc
Set to true to sort results in ascending order.

Returns

Returns an array of NodeRefs.

Example

The following snippet would return all users whose first or last names contained the string "fred", sorted in ascending order on lastName. The results are limited to a maximum of 10 results:

    model.users = people.getPeople("fred", 10, "lastName", true);    
        

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.