Module: alfresco/lists/UserList

alfresco/lists/UserList

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

Extends

Members

followedUsers :object[]

This will be populated with the array of the users that the current user is following. It is used to augment the loaded data so that it is possible to indicate which users are being followed.
Type:
  • object[]
Default Value:
  • null
Source:

followedUsersSuccessTopic :string

This is the topic that is set as a success topic to be published on when publishing requests for the users that are being followed by the current user.
Type:
  • string
Default Value:
  • null
Source:

i18nRequirements :object[]

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

loadDataPublishTopic :string

Overrides the default value to make a request to get users.
Type:
  • string
Source:

widgetsForFilters :object[]

Overrides the default filters as there should be no filters for user lists unless explicitly configured.
Type:
  • object[]
Default Value:
  • null
Source:

<inner> _followedUsersPromise :Deferred

This is reset to a promise before users are loaded and is resolved when the users being followed by the current user have been loaded.
Type:
  • Deferred
Default Value:
  • null
Source:

Methods

loadData(parameters)

Extends the inherited function to publish a request to retrieve the users that the current user is following.
Parameters:
Name Type Argument Description
parameters object <optional>
 An optional parameters object providing information about the data to load
Source:
Fires:

onFollowedUserResults(response, originalRequestConfig)

Updates the followedUsers with the loaded data.
Parameters:
Name Type Description
response object The response from the request
originalRequestConfig object The configuration passed on the original request
Source:

postCreate()

Run after widget created
Since:
  • 1.0.48
Source:

processLoadedData(response)

This extends the inherited function to merge the followed user data.
Parameters:
Name Type Description
response object The original response.
Source:

renderView()

Extends the inherited function to ensure that data is available about the users being followed by the current user.
Source: