Module: alfresco/services/UserService

alfresco/services/UserService

This service has been provided for working with users. Currently it provides the capability to list users (either in an AlfList or as options in a form control that supports options, such as a Select control). It also provides the ability to set the preferred home page of a user as well as their current status.

It is likely that this service does not yet provide all user related capabilities that may be required - if a capability is missing then please raise a feature request as an issue on the GitHub project

Author:
  • Dave Draper
Copyright:
  • Copyright (C) 2005-2020 Alfresco Software Limited
License:
Source:

Extends

Mixes In

Members

i18nRequirements :object[]

An array of the i18n files to use with this widget.
Type:
  • object[]
Default Value:
  • [{i18nFile: "./i18n/UserService.properties"}]
Source:

PREF_KEY_USER_HOME_PAGE :string

This is the dot-notation preferences property address for the user's home page
Type:
  • string
Default Value:
  • "org.alfresco.share.user.homePage"
Source:

Methods

onFollowUsers(payload)

Handles requests to follow users.
Parameters:
Name Type Description
payload object The details of the users to follow
Since:
  • 1.0.86
Source:

onGetAuthorities(payload)

Handles requests to retrieve authorities (users or groups).
Parameters:
Name Type Description
payload object The request details
Since:
  • 1.0.77
Source:

onGetFollowedUsers(payload)

Parameters:
Name Type Description
payload object Additional details for the request.
Since:
  • 1.0.86
Source:

onGetFollowingUsers(payload)

Parameters:
Name Type Description
payload object Additional details for the request.
Since:
  • 1.0.86
Source:

onGetUser(payload)

Handles requests to retrieve a single user.
Parameters:
Name Type Description
payload object The published payload with the userName of the user to retrieve
Since:
  • 1.0.86
Source:

onGetUsers(payload)

Handles requests to retrieve all users from the Alfresco Repository.
Parameters:
Name Type Description
payload object The payload for the request
Since:
  • 1.0.60
Source:

onSetUserHomePage(payload)

Sets the user's home page.
Parameters:
Name Type Description
payload object
Source:

onSetUserHomePageFailure()

Displays a message indicating failure to save of user's home page.
Source:
Listens to Events:
  • event:setUserHomePageTopicFailure

onSetUserHomePageSuccess()

Displays a message indicating successful save of user's home page.
Source:
Listens to Events:
  • event:setUserHomePageTopicSuccess

onUnfollowUsers(payload)

Handles requests to unfollow users.
Parameters:
Name Type Description
payload object The details of the users to follow
Since:
  • 1.0.86
Source:

onUserFailure(response, originalRequestConfig)

This is the failure callback for the onGetUser function.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Since:
  • 1.0.86
Source:

onUsersFailure(response, originalRequestConfig)

This is the failure callback for the onGetUsers function.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Since:
  • 1.0.60
Source:

onUsersSuccess(response, originalRequestConfig)

This is the success callback for the onGetUsers function.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Since:
  • 1.0.60
Source:

onUserSuccess(response, originalRequestConfig)

Handles successful requests to get users filtered by the supplied user name. Makes an additional XHR request to determine whether or not the user is being followed by the current user.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Since:
  • 1.0.86
Source:

publishUser(response, originalRequestConfig)

This is the success callback for the onGetUser function.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Since:
  • 1.0.86
Source:

registerSubscriptions()

Sets up the subscriptions for the UserService
Since:
  • 1.0.32
Source:
Listens to Events:

updateUserStatus(data)

Handles XHR posting to a new user status mesage to the server.
Parameters:
Name Type Description
data object The payload containing the user status to post.
Source:

userStatusUpdateFailure(response, originalRequestConfig)

This handles failed attempts to update the user status.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Source:

userStatusUpdateSuccess(response, originalRequestConfig)

This handles successfully completed requests to update the user status.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Source: