Package org.alfresco.rest.api

Interface People

All Known Implementing Classes:

PeopleImpl

public interface People

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_USER
static java.lang.String	PARAM_FIRST_NAME
static java.lang.String	PARAM_ID
static java.lang.String	PARAM_INCLUDE_ASPECTNAMES
static java.lang.String	PARAM_INCLUDE_CAPABILITIES
static java.lang.String	PARAM_INCLUDE_PROPERTIES
static java.lang.String	PARAM_LAST_NAME

Method Summary

Modifier and Type	Method	Description
Person	create(Person person)	Create a person.
void	deleteAvatarContent(java.lang.String personId)
BinaryResource	downloadAvatarContent(java.lang.String personId, Parameters parameters)
org.alfresco.service.cmr.repository.NodeRef	getAvatar(java.lang.String personId)
CollectionWithPagingInfo<Person>	getPeople(Parameters parameters)	Get people list
Person	getPerson(java.lang.String personId)	Get a person.
Person	getPerson(java.lang.String personId, java.util.List<java.lang.String> include)	Get a person, specifying optional includes as required.
void	requestPasswordReset(java.lang.String userId, java.lang.String client)	Request password reset (an email will be sent to the registered email of the given userId).
void	resetPassword(java.lang.String personId, PasswordReset passwordReset)	Performs password reset
Person	update(java.lang.String personId, Person person)	Update the given person's details.
Person	uploadAvatarContent(java.lang.String personId, BasicContentInfo contentInfo, java.io.InputStream stream, Parameters parameters)
java.lang.String	validatePerson(java.lang.String personId)
java.lang.String	validatePerson(java.lang.String personId, boolean validateIsCurrentUser)

Field Detail

DEFAULT_USER

static final java.lang.String DEFAULT_USER

See Also:

Constant Field Values

PARAM_INCLUDE_ASPECTNAMES

static final java.lang.String PARAM_INCLUDE_ASPECTNAMES

See Also:

Constant Field Values

PARAM_INCLUDE_PROPERTIES

static final java.lang.String PARAM_INCLUDE_PROPERTIES

See Also:

Constant Field Values

PARAM_INCLUDE_CAPABILITIES

static final java.lang.String PARAM_INCLUDE_CAPABILITIES

See Also:

Constant Field Values

PARAM_FIRST_NAME

static final java.lang.String PARAM_FIRST_NAME

See Also:

Constant Field Values

PARAM_LAST_NAME

static final java.lang.String PARAM_LAST_NAME

See Also:

Constant Field Values

PARAM_ID

static final java.lang.String PARAM_ID

See Also:

Constant Field Values

Method Detail

validatePerson

java.lang.String validatePerson(java.lang.String personId)

validatePerson

java.lang.String validatePerson(java.lang.String personId,
                                boolean validateIsCurrentUser)

getAvatar

org.alfresco.service.cmr.repository.NodeRef getAvatar(java.lang.String personId)

getPerson

Person getPerson(java.lang.String personId)

Get a person. This included a full representation of the person.

Throws:

org.alfresco.service.cmr.security.NoSuchPersonException - if personId does not exist

getPerson

Person getPerson(java.lang.String personId,
                 java.util.List<java.lang.String> include)

Get a person, specifying optional includes as required.

Parameters:

personId -

include -

Returns:

create

Person create(Person person)

Create a person.

Parameters:

person -

Returns:

update

Person update(java.lang.String personId,
              Person person)

Update the given person's details.

Parameters:

personId - The identifier of a person.

person - The person details.

Returns:

The updated person details.

getPeople

CollectionWithPagingInfo<Person> getPeople(Parameters parameters)

Get people list

Returns:

CollectionWithPagingInfo

requestPasswordReset

void requestPasswordReset(java.lang.String userId,
                          java.lang.String client)

Request password reset (an email will be sent to the registered email of the given userId). The API returns a 202 response for a valid, as well as the invalid (does not exist or disabled) userId

Parameters:

userId - the user id of the person requesting the password reset

client - the client name which is registered to send emails

resetPassword

void resetPassword(java.lang.String personId,
                   PasswordReset passwordReset)

Performs password reset

Parameters:

passwordReset - the password reset details

downloadAvatarContent

BinaryResource downloadAvatarContent(java.lang.String personId,
                                     Parameters parameters)

Parameters:

personId -

parameters -

Returns:

uploadAvatarContent

Person uploadAvatarContent(java.lang.String personId,
                           BasicContentInfo contentInfo,
                           java.io.InputStream stream,
                           Parameters parameters)

Parameters:

personId -

contentInfo -

stream -

parameters -

Returns:

deleteAvatarContent

void deleteAvatarContent(java.lang.String personId)

Parameters:

personId -