Module: alfresco/core/topics

alfresco/core/topics

This module is intended to contain ALL topics used by the Aikau framework. Widgets that require topics for publications or subscriptions should add this module as a dependency and then use a topic listed as the default. This then allows configuration overrides as necessary.

Author:
  • Martin Doyle
  • Dave Draper
License:
Source:

Members

ARCHIVE_PROGRESS_FAILURE :String

Triggered when the progress request has failed
Type:
  • String
Since:
  • 1.0.33
Default Value:
  • "ALF_ARCHIVE_PROGRESS_REQUEST_FAILURE"
Source:

ARCHIVE_PROGRESS_SUCCESS :string

Triggered when the progress request has succeeded.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_ARCHIVE_PROGRESS_REQUEST_SUCCESS"
Source:

CANCEL_EDIT :string

Event topic to trigger the cancel the editing of a checkout document
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_DOC_CANCEL_EDITING"
Source:

CLEAR_SELECTED_ITEMS :string

This can be published to clear any selected items that are logged by widgets such as the AlfSelectedItemsMenuBarPopup.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_CLEAR_SELECTED_ITEMS"
Source:

CREATE_DIALOG :string

This can be published to make a request to create a dialog. It is typically handled by the DialogService.
Type:
  • string
Since:
  • 1.0.34
Default Value:
  • "ALF_CREATE_DIALOG_REQUEST"
Source:

CREATE_FORM_DIALOG :string

This can be published to make a request to create a dialog that contains a form. This differs from the standard dialog request in that the payload is expected to contain a widget model containing the form controls to be placed inside the dialog. The confirmation buttons of the dialog are automatically setup to respond to changes of validity within the form.
Type:
  • string
Since:
  • 1.0.34
Default Value:
  • "ALF_CREATE_FORM_DIALOG_REQUEST"
Source:

DELETE_ARCHIVE :string

Delete the archive created for downloading.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_ARCHIVE_DELETE"
Source:

DELETE_CONTENT :string

This topic is published to request the deletion of a node.
Type:
  • string
Since:
  • 1.0.34
Default Value:
  • "ALF_DELETE_CONTENT_REQUEST"
Source:

DOWNLOAD_AS_ZIP :string

This topic is published to request either the download of a single document or folder (or a selection of documents and folder) as a ZIP file.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_DOWNLOAD_AS_ZIP"
Source:

DOWNLOAD_NODE :string

Event topic to trigger a file download in the browser
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_DOWNLOAD_FILE"
Source:

GET_DOCUMENT :string

This topic can be published to request the data for a single document node. It is typically handled by the DocumentService.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_RETRIEVE_SINGLE_DOCUMENT_REQUEST"
Source:

GET_DOCUMENT_LIST :string

This topic can be published to request the data for a list of documents at the location provided in the payload. It is typically handled by the DocumentService.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_RETRIEVE_DOCUMENTS_REQUEST"
Source:

GET_DOCUMENT_LIST_SUCCESS :string

This topic is typically published as a result of request to load documents by publishing GET_DOCUMENT_LIST. It will contain the results of the request and can have a varying payload depending upon the API being used.
Type:
  • string
Since:
  • 1.0.51
Default Value:
  • "ALF_RETRIEVE_DOCUMENTS_REQUEST_SUCCESS"
Source:

GET_PARENT_NODEREF :string

Get the node ref for the current node's parent.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_DOC_GET_PARENT_NODEREF"
Source:

NOTIFICATION_CLOSED :string

This topic is fired automatically whenever a notification is destroyed.
Type:
  • string
Default Value:
  • "ALF_NOTIFICATION_CLOSED"
Source:

PAGE_WIDGETS_READY :string

This topic is published when the page has finished loading. It should also be published when dynamically creating widgets after the page has finished loading.
Type:
  • string
Default Value:
  • "ALF_WIDGETS_READY"
Source:

PATH_CHANGED :string

This topic is published when a path changed. It is typically used in Document Libraries to communicate navigation through a folder hierarchy to both request data and to keep navigation widgets synchronized (e.g. Document Lists and [Path Trees]module:alfresco/navigation/PathTree).
Type:
  • string
Default Value:
  • "ALF_DOCUMENTLIST_PATH_CHANGED"
Source:

REQUEST_ARCHIVE :string

Called to start off the archiving process.
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_ARCHIVE_REQUEST"
Source:

REQUEST_ARCHIVE_PROGRESS :string

Called to trigger a request to check progress
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_ARCHIVE_PROGRESS_REQUEST"
Source:

REQUEST_DELAYED_ARCHIVE_PROGRESS :string

Called to trigger a delayed request to check progress delay is set in archiveProgressUpdateFailureInterval
Type:
  • string
Since:
  • 1.0.33
Default Value:
  • "ALF_ARCHIVE_DELAYED_PROGRESS_REQUEST"
Source:

SCROLL_NEAR_BOTTOM :string

This topic is used to indicate that a navigable collection has been scrolled to "near" its bottom. Since its creation, this topic's meaning has extended to go beyond just scrolling (sometimes it's clicking arrows) and to not necessarily being the bottom (sometimes it's a horizontal navigation), however in order to preserve backward compatibility, this has been left unchanged.

NOTE: In future this is very likely to be deprecated and eventually removed, so be sure to use the constant (not its value) and to watch out for deprecated references in your codebase.

Type:
  • string
Since:
  • 1.0.32
Default Value:
  • "ALF_SCROLL_NEAR_BOTTOM"
Source:

SET_PREFERENCE :string

This topic can be published to set a user preference. It is typically handled by the PreferenceService.
Type:
  • string
Since:
  • 1.0.34
Default Value:
  • "ALF_PREFERENCE_SET"
Source:

SYNC_TO_CLOUD :string

This topic is published in order to make the actual request to sync a node or nodes with the Cloud.
Type:
  • string
Since:
  • 1.0.39
Default Value:
  • "ALF_SYNC_TO_CLOUD"
Source:

SYNC_TO_CLOUD_SUCCESS :string

This topic is published when a Cloud sync is successfully created.
Type:
  • string
Since:
  • 1.0.39
Default Value:
  • "ALF_SYNC_TO_CLOUD_SUCCESS"
Source:

UPLOAD_TO_UNKNOWN_LOCATION :string

This topic can be published to display a dialog that allows users to select one or more files to upload and the location to upload them to. This is typically handled by the ContentService.
Type:
  • string
Since:
  • 1.0.34
Default Value:
  • "ALF_UPLOAD_TO_UNKNOWN_LOCATION"
Source:

WIDGET_PROCESSING_COMPLETE :string

This topic is published to indicate that widget processing has been completed. It is typically fired by widgets that dynamically render widget models.
Type:
  • string
Since:
  • 1.0.35
Default Value:
  • "ALF_WIDGET_PROCESSING_COMPLETE"
Source:

Events

ADD_FAVOURITE_NODE

This can be published to request to add a node or nodes as a favourite.
Type:
  • String
Properties:
Name Type Description
node object The node to add as a favourite
nodes object[] An array of nodes to add as a favourites
Since:
  • 1.0.38
Default Value:
  • "ALF_PREFERENCE_ADD_DOCUMENT_FAVOURITE"
Source:
Listeners of This Event:

ADD_FAVOURITE_SITE

This can be published to request to add a site as a favourite.
Type:
  • String
Properties:
Name Type Description
site string The shortName of the site to add as a favourite
user string The username of the user to make the site a favourite of
Since:
  • 1.0.94
Default Value:
  • "ALF_ADD_FAVOURITE_SITE"
Source:
Listeners of This Event:

ASSIGN_WORKFLOW

The topic to publish to request starting a new workflow for one or more Nodes.
Type:
  • string
Properties:
Name Type Description
nodes object[] The array of Nodes to start the workflow on
currentTarget object The current Node in which the nodes reside
Since:
  • 1.0.36
Default Value:
  • "ALF_ASSIGN_WORKFLOW"
Source:
Listeners of This Event:

BECOME_SITE_MANAGER

Type:
  • string
Properties:
Name Type Argument Default Description
site string The site shortname to change the user role in
role string <optional>
SiteManager The role for the user to become
user string <optional>
The userid to change the role for
Since:
  • 1.0.52
Default Value:
  • "ALF_BECOME_SITE_MANAGER"
Source:
Listeners of This Event:

CANCEL_INPROGRESS_UPLOAD

Cancel an in-progress upload.
Type:
  • string
Properties:
Name Type Description
fileId string The ID of the file to cancel
Since:
  • 1.0.56
Default Value:
  • "CANCEL_INPROGRESS_UPLOAD"
Source:

CANCEL_JOIN_SITE_REQUEST

Cancel a request to join a site.
Type:
  • string
Properties:
Name Type Description
siteId string The ID of the site
siteTitle string The "friendly" name of the site
pendingInvite object The object describing the pending invite
Properties
Name Type Description
id string The ID of the pending site-join request
Since:
  • 1.0.58
Default Value:
  • "ALF_CANCEL_JOIN_SITE_REQUEST"
Source:

CHANGE_TYPE_REQUEST

This topic is published to request the options to change the type of a node. It doesn't perform the actual change, but simply provides the type change options in a dialog.
Type:
  • string
Properties:
Name Type Argument Description
node object <optional>
An object representing the full metadata of the Node to change the type of
nodeRef string <optional>
The NodeRef of the Node to retrieve the full metadata of in order to change its type
Since:
  • 1.0.58
Default Value:
  • "ALF_CHANGE_TYPE_REQUEST"
Source:
Listeners of This Event:

CLOUD_AUTHENTICATION_REQUEST

This can be published to request authentication to the Cloud for the purposes of sync'ing Alfresco Repository content with the Alfresc Cloud.
Type:
  • string
Properties:
Name Type Description
username string The username to authenticate (this should be the e-mail address associated with the Cloud)
password string The password to authenticate with
Since:
  • 1.0.39
Default Value:
  • "ALF_CLOUD_AUTHENTICATION_REQUEST"
Source:
Listeners of This Event:

CLOUD_AUTHENTICATION_SUCCESS

This can be published to indicate that authentication to the Cloud for the purposes of sync'ing Alfresco Repository content with the Alfresc Cloud has completed successfully.
Type:
  • string
Since:
  • 1.0.39
Default Value:
  • "ALF_CLOUD_AUTHENTICATION_SUCCESS"
Source:

CONTENT_CREATED

This is fired when content is created (typically by the ContentService) and was added to that [trees]module:alfresco/navigation/PathTree would be able to refresh themselves following content creation.
Type:
  • string
Properties:
Name Type Description
parentNodeRef string The nodeRef of the parent that the content was created within
nodeRef string The nodeRef of the created content
Since:
  • 1.0.48
Default Value:
  • "ALF_CONTENT_CREATED"
Source:

CONTENT_CREATION_FAILED

This is fired when content cannot be created (typically by the ContentService)
Type:
  • string
Since:
  • 1.0.64
Default Value:
  • "ALF_CONTENT_CREATION_FAILURE"
Source:

CONTENT_DELETED

This is fired when content is deleted (typically by the ContentService) and was added to that [trees]{@link module:alfresco/navigation/PathTree} would be able to refresh themselves following content deletion.
Type:
  • string
Properties:
Name Type Description
nodeRef string[] The nodeRefs of the content that has been deleted.
Since:
  • 1.0.48
Default Value:
  • "ALF_CONTENT_DELETED"
Source:
Listeners of This Event:

CREATE_CONTENT_REQUEST

This can be published to make a request to create content in the Alfresco Repository. It is typically handled by the ContentService.
Type:
  • string
Parameters:
Name Type Argument Default Description
currentNode object <optional>
The metadata about the node in which to create content
Properties
Name Type Argument Description
nodeRef string <optional>
The nodeRef of the node in which to create content
type string <optional>
"cm:content" The type of content to create
Since:
  • 1.0.64
Default Value:
  • "ALF_CREATE_CONTENT_REQUEST"
Source:
Listeners of This Event:

CREATE_SITE

This can be published to make a request to show a new dialog for creating sites. This is typically handled by the SiteService.
Type:
  • string
Since:
  • 1.0.55
Default Value:
  • "ALF_CREATE_SITE"
Source:
Listeners of This Event:

CREATE_TAG

Create a new tag
Type:
  • string
Properties:
Name Type Description
tagName string The name of the tag to create
alfResponseTopic string The topic on which to respond
Since:
  • 1.0.37
Default Value:
  • "ALF_CREATE_TAG"
Source:
Listeners of This Event:

DATA_LIST_UPDATED

This topic is published from the DataListService when a Data List has had it's title and/or description updated.
Type:
  • string
Properties:
Name Type Description
nodeRef string The NodeRef of the Data List that has been updated
title string The new title of the Data List
description string The new description of the Data List
Since:
  • 1.0.85
Default Value:
  • "ALF_DATA_LIST_UPDATED"
Source:

DELETE_DATA_LIST

This topic is published to request the deletion of a Data List.
Type:
  • string
Properties:
Name Type Description
nodeRef string The NodeRef of the Data List to delete
Since:
  • 1.0.85
Default Value:
  • "ALF_DELETE_DATA_LIST_REQUEST"
Source:
Listeners of This Event:

DELETE_DATA_LIST_CONFIRMATION

This topic is published when the user confirms that they wish to delete a Data List.
Type:
  • string
Properties:
Name Type Description
nodeRef string The NodeRef of the Data List to delete
Since:
  • 1.0.85
Default Value:
  • "ALF_DELETE_DATA_LIST_CONFIRMATION"
Source:
Listeners of This Event:

DELETE_DATA_LIST_ITEMS

This topic is published to request the deletion of a itemS from a Data List.
Type:
  • string
Properties:
Name Type Description
nodeRefs string[] The NodeRef of the Data List to delete
Since:
  • 1.0.86
Default Value:
  • "ALF_DELETE_DATA_LIST_ITEMS_REQUEST"
Source:
Listeners of This Event:

DELETE_DATA_LIST_ITEMS_CONFIRMATION

This topic is published when the user confirms that they wish to delete items from a Data List.
Type:
  • string
Properties:
Name Type Description
nodeRefs string The NodeRefs of the items to delete
Since:
  • 1.0.86
Default Value:
  • "ALF_DELETE_DATA_LIST_ITEMS_CONFIRMATION"
Source:
Listeners of This Event:

DELETE_DATA_LIST_SUCCESS

This topic is published when a Data List has been successfully deleted.
Type:
  • string
Properties:
Name Type Description
nodeRef string The NodeRef of the Data List to delete
Since:
  • 1.0.85
Default Value:
  • "ALF_DELETE_DATA_LIST_SUCCESS"
Source:

DIALOG_CHANGE_TITLE

This topic is published to request a title change in the current, top-most dialog.
Type:
  • string
Properties:
Name Type Description
title string The new title
Since:
  • 1.0.52
Default Value:
  • "ALF_DIALOG_CHANGE_TITLE"
Source:
Listeners of This Event:

DISABLE_SITE_ACTIVITY_FEED

This topic can be published to disabled the activity feed for a site.
Type:
  • string
Since:
  • 1.0.87
Default Value:
  • "ALF_DISABLE_SITE_ACTIVITY_FEED"
Source:

DISPLAY_NOTIFICATION

This topic can be published to request that a notification be displayed. It is subscribed to by the NotificationService.
Type:
  • string
Properties:
Name Type Argument Default Description
message string The message to be displayed
autoClose string <optional>
true Whether the notification should automatically close itself
wordsPerSecond number <optional>
5 How many words it is assumed one can read per second (decrease this number to increase the duration of the notification being displayed on-screen - assuming autoClose hasn't been disabled)
widgets object[] <optional>
Widgets to be inserted into the notification below the message. Note that any widgets required must be either statically declared in the page model or in a widgets property of a custom widget/service, or be specifically required by a custom widget/service.
closeTopic string <optional>
If this topic is published to, then the notification will be closed
publishTopic string <optional>
A topic to be published after the notification has closed
publishPayload object <optional>
The payload to be published after the notification has closed
publishGlobal boolean <optional>
Whether to publish the topic globally
publishToParent boolean <optional>
Whether to publish the topic on the parent scope
Default Value:
  • "ALF_DISPLAY_NOTIFICATION"
Source:
Listeners of This Event:

DISPLAY_PROMPT

This topic can be published to request that a prompt be displayed. It is subscribed to by the NotificationService.
Type:
  • string
Properties:
Name Type Argument Description
message string The message to be displayed in the prompt
title string <optional>
The title of the prompt
Default Value:
  • "ALF_DISPLAY_PROMPT"
Source:

DISPLAY_STICKY_PANEL

This topic can be published to request that a StickyPanel be displayed. It is subscribed to by the NotificationService.
Type:
  • string
Properties:
Name Type Argument Default Description
widgets object[] The widgets to appear in the panel
title string <optional>
default.title The title to display (uses i18n)
closeButtonLabel string <optional>
Close this panel The text-label that decorates the close button for accessibility reasons
minimiseButtonLabel string <optional>
Minimize this panel The text-label that decorates the minimise button for accessibility reasons
restoreButtonLabel string <optional>
Restore this panel The text-label that decorates the restore button for accessibility reasons
padding number <optional>
10 The padding to be applied to the widgets area
width string | number <optional>
50% The width of the panel (CSS dimension or number of pixels)
warnIfOpen boolean <optional>
true Whether to put a warning in the console if the panel is already visible
callback function <optional>
The function to call after panel created (or if it already exists) with the panel instance as the first and only argument
Since:
  • 1.0.48
Default Value:
  • "ALF_DISPLAY_STICKY_PANEL"
Source:
Listeners of This Event:

DOCUMENT_TAGGED

Fired when a "document" has been tagged
Type:
  • string
Since:
  • 1.0.37
Default Value:
  • "ALF_DOCUMENT_TAGGED"
Source:
Listeners of This Event:

DOCUMENTLIST_TAG_CHANGED

Fired when a tag has been chosen to filter a document list.
Type:
  • string
Properties:
Name Type Description
description string A textual description of this tag
value string The name of the tag on which to filter
Since:
  • 1.0.37
Default Value:
  • "ALF_DOCUMENTLIST_TAG_CHANGED"
Source:
Listeners of This Event:

DOWNLOAD

This topic is published to request the download of a single document
Type:
  • string
Properties:
Name Type Argument Description
node object <optional>
An object containing the node data.
Properties
Name Type Argument Description
contentURL string <optional>
The URL to use for the node to download
Since:
  • 1.0.43
Default Value:
  • "ALF_DOWNLOAD"
Source:
Listeners of This Event:

DOWNLOAD_ON_NODE_RETRIEVAL_SUCCESS

This topic subscribed to by the DocumentService in order to trigger a download of a node that has just had its full metadata successfully retrieved. This is not intended to be used by widgets or services other than the DocumentService.
Type:
  • string
Properties:
Name Type Description
response object The reponse from the XHR request to retrieve the node metadata
Properties
Name Type Description
item object The metadata for the requested node
Since:
  • 1.0.43
Default Value:
  • "ALF_DOWNLOAD_ON_NODE_RETRIEVAL_SUCCESS"
Source:
Listeners of This Event:

EDIT_SITE

This topic can be published to display a dialog that allow the details of a site to be edited.
Type:
  • string
Since:
  • 1.0.55
Default Value:
  • "ALF_EDIT_SITE"
Source:
Listeners of This Event:

ENABLE_SITE_ACTIVITY_FEED

This topic can be published to enable the activity feed for a site.
Type:
  • string
Since:
  • 1.0.87
Default Value:
  • "ALF_ENABLE_SITE_ACTIVITY_FEED"
Source:

ENTER_KEY_PRESSED

This topic can be fired when the enter key is pressed (but normally is not by default).
Type:
  • string
Since:
  • 1.0.49
Default Value:
  • "ALF_ENTER_KEY_PRESSED"
Source:

FILTER_REMOVED

Published when an a list filter is removed from the filter summary
Type:
  • string
Since:
  • 1.0.54
Default Value:
  • "ALF_FILTER_REMOVED"
Source:

FILTER_VALUE_CHANGE

Published when a filter is removed in order to allow form controls representing the filter to update their rendering of the current filter value.
Type:
  • string
Properties:
Name Type Description
name string The name of the form control to update
value string The value to set on the form control
Since:
  • 1.0.54
Default Value:
  • "ALF_FILTER_VALUE_CHANGED"
Source:

FILTERS_APPLIED

This is published by the filtered list to indicate what filters have been applied to the list.
Type:
  • string
Since:
  • 1.0.54
Default Value:
  • "ALF_FILTERS_APPLIED"
Source:
Listeners of This Event:

FILTERS_CLEARED

This function is both published from and subcribed to by the filter summary to request that all filters are cleared.
Type:
  • string
Since:
  • 1.0.54
Default Value:
  • "ALF_FILTERS_CLEARED"
Source:
Listeners of This Event:

FOLLOW_USERS

This topic can be published to request that the current user follow the users provided.
Type:
  • string
Properties:
Name Type Description
userNames string[] An array of the userNames of the users to follow.
Since:
  • 1.0.86
Default Value:
  • "ALF_FOLLOW_USERS"
Source:
Listeners of This Event:

GET_AUTHORITIES

This topic can be published to request a list of authorities to be returned (e.g. users or groups).
Type:
  • string
Parameters:
Name Type Argument Default Description
selectableType string <optional>
"cm:person" The type of authority to retrieve
query string <optional>
"" The search query to provide
size number <optional>
1000 The maximum number of results to return
Since:
  • 1.0.78
Default Value:
  • "ALF_GET_AUTHORITIES"
Source:
Listeners of This Event:

GET_CLOUD_PATH

This topic can be used to request Cloud specific paths to use in an Tree form control.
Type:
  • string
Properties:
Name Type Description
remoteSiteId string The site on the Cloud tenant from which to retrieve path data
remoteTenantId string The tenant on the Cloud on which the remoteSiteId can be found
Since:
  • 1.0.39
Default Value:
  • "ALF_GET_CLOUD_PATH"
Source:
Listeners of This Event:

GET_CLOUD_SITES

This topic can be used from a form control such as a [Select]{@link module:alfresco/forms/controls/Select} as the optionsConfig.publishTopic for retrieving the sites on a specified Cloud tenant (network) that the user has access to.
Type:
  • string
Properties:
Name Type Description
username string The username to request site data for
remoteTenantId string The tenant on which to look for sites
Since:
  • 1.0.39
Default Value:
  • "ALF_GET_CLOUD_SITES"
Source:
Listeners of This Event:

GET_CLOUD_TENANTS

This topic can be used from a form control such as a [Select]{@link module:alfresco/forms/controls/Select} as the optionsConfig.publishTopic for retrieving the Cloud tenants (networks) that the user has access to.
Type:
  • string
Since:
  • 1.0.39
Default Value:
  • "ALF_GET_CLOUD_TENANTS"
Source:
Listeners of This Event:

GET_DATA_LIST_ITEMS

This topic can be used to request items for a particular Data Lists
Type:
  • string
Properties:
Name Type Description
nodeRef string The NodeRef of the Data List to get items for
Since:
  • 1.0.86
Default Value:
  • "ALF_GET_DATA_LIST_ITEMS"
Source:
Listeners of This Event:

GET_DATA_LIST_WIDGETS

This topic can be used to handle requests to build a widget model for displaying a list showing the items in a specific Data List
Type:
  • string
Properties:
Name Type Argument Description
nodeRef string The NodeRef of the Data List to display
itemType string The type of Data List to display
alfResponseTopic string <optional>
An optional topic to publish the widget model on.
Since:
  • 1.0.85
Default Value:
  • "ALF_GET_DATA_LIST_WIDGETS"
Source:
Listeners of This Event:

GET_DATA_LISTS

This topic can be used to request the Data Lists for the supplied site
Type:
  • string
Properties:
Name Type Description
siteId string The id of the site to get the Data Lists for
Since:
  • 1.0.85
Default Value:
  • "ALF_GET_DATA_LISTS"
Source:
Listeners of This Event:

GET_FAVOURITE_SITES

This topic can be published to retrieve a list of the sites that have marked as a favourite of the current user. Unfortunately at the present time this cannot be used for requesting form control options.
Type:
  • string
Since:
  • 1.0.81
Default Value:
  • "ALF_GET_FAVOURITE_SITES"
Source:
Listeners of This Event:

GET_FOLLOWED_USERS

This can be published to request the list of users that the current user is following.
Type:
  • string
Since:
  • 1.0.86
Default Value:
  • "ALF_GET_FOLLOWED_USERS"
Source:
Listeners of This Event:

GET_FOLLOWING_USERS

This can be published to request the list of users that are following the current user.
Type:
  • string
Since:
  • 1.0.86
Default Value:
  • "ALF_GET_FOLLOWING_USERS"
Source:
Listeners of This Event:

GET_FORM_CONTROL_OPTIONS

This topic can be published to request the generation of options for a form control such as [Select]{@link module:alfresco/forms/controls/Select} or RadioButtons. By default it is handled by the OptionsService.
Type:
  • string
Properties:
Name Type Argument Default Description
url string The URL to retrieve the options from
itemsAttribute string <optional>
"" The dot-notation address of items array (e.g. "data")
labelAttribute string The dot-notation for label within each item (e.g. "displayName")
valueAttribute string The dot-notation for value within each item (e.g. "fullName")
resultsProperty string <optional>
"response" Required for form controls that use a ServiceStore
responseTopic string This will be automatically provided by the form controls
Since:
  • 1.0.98
Default Value:
  • "ALF_GET_FORM_CONTROL_OPTIONS"
Source:
Listeners of This Event:

GET_FORM_VALUE_DEPENDENT_OPTIONS

This topic can be published by a form control when it needs to retrieve options that can only be determined from other values containined within the form. This allows options to be dynamically requested that change as other form values are updated.
Type:
  • string
Properties:
Name Type Argument Default Description
publishTopic string The topic publish the payload once augmented with the form value.
publishPayloadModifiers string[] <optional>
[] Modifiers to apply to the payload
Since:
  • 1.0.39
Default Value:
  • "ALF_GET_FORM_VALUE_DEPENDENT_OPTIONS"
Source:
Listeners of This Event:

GET_FORMS_FORMS_RUNTIME_MIMETYPES

This topic is used by the FormsRuntimeService as a simple way of providing the MIME type data for mapped Share Forms Runtime controls. Specifically the "/org/alfresco/components/form/controls/mimetype.ftl" control.
Type:
  • string
Since:
  • 1.0.77
Default Value:
  • "ALF_GET_FORMS_RUNTIME_MIMETYPE"
Source:
Listeners of This Event:

GET_RECENT_SITES

This topic can be published to retrieve a list of the sites that have recently been visited by the current user. Unfortunately at the present time this cannot be used for requesting form control options.
Type:
  • string
Since:
  • 1.0.81
Default Value:
  • "ALF_GET_RECENT_SITES"
Source:
Listeners of This Event:

GET_SITES

This topic can be published to retrieve a list of all the sites that are accessible to the current user. Unfortunately at the present time this cannot be used for requesting form control options.
Type:
  • string
Properties:
Name Type Argument Default Description
includeFeedSettings boolean <optional>
false Indicates whether feed control data should be retrieved
Since:
  • 1.0.81
Default Value:
  • "ALF_GET_SITES"
Source:
Listeners of This Event:

GET_USER

This topic can be published to retrieve the details of a single user.
Type:
  • string
Properties:
Name Type Description
userName string The userName of the user to retrieve
Since:
  • 1.0.86
Default Value:
  • "ALF_GET_USER"
Source:

GET_USER_SITES

This topic can be published to get a list of the sites that a user belongs to.
Type:
  • string
Since:
  • 1.0.87
Default Value:
  • "ALF_GET_USER_SITES"
Source:
Listeners of This Event:

GET_USERS

This topic can be published to request a list of all available users in the Alfresco Repository. This request is expected to be handled by the UserService. The results are published on 'alfResponseTopic' provided, and are defined as an array as attribute "items" in the published payload.
Type:
  • string
Properties:
Name Type Description
alfResponseTopic string The topic on which to publish the users data
Since:
  • 1.0.60
Default Value:
  • "ALF_GET_USERS"
Source:
Listeners of This Event:

INIT_CLOUD_SYNC

Can be published to initialise the creation of a synchronization between an on-premise node and a location on the Alfresco Cloud.
Type:
  • string
Since:
  • 1.0.39
Default Value:
  • "ALF_INIT_CLOUD_SYNC"
Source:
Listeners of This Event:

MULTIPLE_ITEM_ACTION_REQUEST

This can be published to request that an action be performed on multiple selected items. The selected items are tracked by either the ActionService or preferrably a AlfSelectedItemsMenuBarPopup.
Type:
  • string
Properties:
Name Type Description
action string The action to perform (this should map to a function in the ActionService)
actionTopic string A topic to forward the action request on to.
Since:
  • 1.0.38
Source:
Listeners of This Event:

NAVIGATE_TO_PAGE

This topic can be published to request navigation to another URL.
Type:
  • string
Properties:
Name Type Argument Default Description
url string The URL to navigate to
type string <optional>
PAGE_RELATIVE The type of navigation
target string <optional>
CURRENT Whether to use the "CURRENT" tab, open in a "NEW" tab, or use a "NAMED" tab
targetName string <optional>
The name of the tab to create when using "NAMED" as the target value
modifyCurrent string <optional>
false Whether to modify the current hash (default is to completely replace it)
Since:
  • 1.0.35
Default Value:
  • "ALF_NAVIGATE_TO_PAGE"
Source:
Listeners of This Event:

NODE_RESIZED

This topic is published from the alfPublishResizeEvent function. To publish this this topic a widget should mixin the ResizeMixin and call that function and to subscribe to it, a module should mixin the ResizeMixin and call the alfSetupResizeSubscriptions to set up callback handlers for resizing.
Type:
  • string
Properties:
Name Type Description
node element The DOM node that has been resized
Since:
  • 1.0.36.1
Default Value:
  • "ALF_NODE_RESIZED"
Source:

PREVIEW_MODEL_RENDER_REQUEST

Used to request the rendering of a model. Typically handled by the preview widget.
Type:
  • string
Properties:
Name Type Description
pageDefinition object The model to render
Properties
Name Type Description
stringified boolean Indicates whether the pageDefinition model is already stringified
publishOnReady object[] Publications to make when the model has finished rendering
services object[] The services to create
widgets object[] The widgets to create
Since:
  • 1.0.54
Default Value:
  • "ALF_GENERATE_PAGE_PREVIEW"
Source:
Listeners of This Event:

PREVIEW_MODEL_RENDERED

This topic is published when preview models have finished rendering.
Type:
  • string
Since:
  • 1.0.54
Default Value:
  • "ALF_PREVIEW_MODEL_RENDERED"
Source:

PREVIEWS_SHOWN

This topic should be published when indicating what previewers are currently displayed. This has been added to support the DocumentCarousel so that audio and video previewers can automatically be stopped and started as they leave are hidden and displayed.
Type:
  • string
Properties:
Name Type Description
items object[] An array of the items that have been displayed.
Since:
  • 1.0.51
Default Value:
  • "ALF_PREVIEWS_SHOWN"
Source:
Listeners of This Event:

PROGRESS_INDICATOR_ADD_ACTIVITY

This topic can be used to denote that an activity has begun, for which a global progress indicator should be shown. This can be called multiple times, and for each "ADD" a corresponding "REMOVE" should be called via the PROGRESS_INDICATOR_REMOVE_ACTIVITY topic. When there are no remaining current activities, the indicator should be hidden.
Type:
  • string
Since:
  • 1.0.71
Default Value:
  • "ALF_PROGRESS_INDICATOR_ADD_ACTIVITY"
Source:
Listeners of This Event:

PROGRESS_INDICATOR_REMOVE_ACTIVITY

This topic can be used to denote that an activity has finished, and that the progress indicator can be removed if no other activities are running. Calling this topic when no activities are running will have no effect.
Type:
  • string
Since:
  • 1.0.71
Default Value:
  • "ALF_PROGRESS_INDICATOR_REMOVE_ACTIVITY"
Source:
Listeners of This Event:

PROGRESS_INDICATOR_REMOVE_ALL_ACTIVITIES

This topic can be used to immediately mark all activities as finished and to therefore remove the progress indicator.
Type:
  • string
Since:
  • 1.0.71
Default Value:
  • "ALF_PROGRESS_INDICATOR_REMOVE_ALL_ACTIVITIES"
Source:
Listeners of This Event:

RELOAD_DATA_TOPIC

This topic is published to indicate that data needs to be uploaded. This is typically list based data but can be used by other widgets.
Type:
  • string
Properties:
Name Type Argument Default Description
focusItemKey string <optional>
null An item to focus on if it is in the data that is reloaded
Since:
  • 1.0.34
Default Value:
  • "ALF_DOCLIST_RELOAD_DATA"
Source:

REMOVE_FAVOURITE_NODE

This can be published to request to remove a node or nodes from the list of favourites.
Type:
  • String
Properties:
Name Type Description
node object The node to remove from favourites
nodes object[] An array of nodes to remove from favourites
Since:
  • 1.0.38
Default Value:
  • "ALF_PREFERENCE_REMOVE_DOCUMENT_FAVOURITE"
Source:
Listeners of This Event:

REQUEST_CONFIRMATION_PROMPT

This can be published to request the user to confirm an action.
Type:
  • string
Properties:
Name Type Argument Default Description
confirmationTitle string <optional>
"Please confirm" The title to show in the dialog
confirmationPrompt string <optional>
"Are you sure?" The prompt message to display in the dialog
confirmationButtonLabel string <optional>
"Yes" The label for the confirmation button
cancellationButtonLabel string <optional>
"No" The label for the cancellation button
confirmationPublication object <optional>
The publication to make on confirmation
Properties
Name Type Argument Description
publishTopic string <optional>
The topic to publish confirmation on
publishPayload object <optional>
The payload to publish on confirmation
publishGlobal boolean <optional>
Whether to publish confirmation globally
publishToParent boolean <optional>
Whether to publish confirmation on the parent scope
publishScope string <optional>
A custom scope to publish confirmation on
cancellationPublication object <optional>
The publication to make on cancellation
Properties
Name Type Argument Description
publishTopic string <optional>
The topic to publish cancellation on
publishPayload object <optional>
The payload to publish on cancellation
publishGlobal boolean <optional>
Whether to publish cancellation globally
publishToParent boolean <optional>
Whether to publish cancellation on the parent scope
publishScope string <optional>
A custom scope to publish cancellation on
Since:
  • 1.0.85
Default Value:
  • "ALF_REQUEST_CONFIRMATION_PROMPT"
Source:

REQUEST_FORM

This can be published to request a form model be retrieved from the forms runtime service.
Type:
  • string
Properties:
Name Type Argument Default Description
itemKind string The type of item for the form (e.g. "node")
itemId string The unique identifier for the item for the form (e.g. a NodeRef)
formId string <optional>
null The unique identifier of the form to be retrieved
alfDestination string <optional>
null A target NodeRef for the for data provided by the form
mode string The mode of form to retrieve (e.g. "view" or "edit")
formConfig object <optional>
null Some optional configuration for the form
Properties
Name Type Argument Default Description
formId string <optional>
null The ID to give to the rendered form
formSubmissionPayloadMixin object <optional>
Some additional data to include in the form submission
useDialog object <optional>
null Indicates whether or not the form should be displayed as a dialog
dialogTitle object <optional>
null The title for the dialog when a dialog is being used
Since:
  • 1.0.76
Default Value:
  • "ALF_FORM_REQUEST"
Source:
Listeners of This Event:

RETRIEVE_CURRENT_TAGS

Retrieve the currently available tags
Type:
  • string
Properties:
Name Type Argument Description
alfResponseTopic string The topic on which to publish the results
query object <optional>
An optional query to pass through with the tags request
Since:
  • 1.0.37
Default Value:
  • "ALF_RETRIEVE_CURRENT_TAGS"
Source:
Listeners of This Event:

SELECTED_DOCUMENTS_ACTION

This topic should be published by menu items contained within a AlfSelectedItemsMenuBarPopup to be forwarded onto the ActionService in order to request that the configured action be performed on the currently selected items.
Type:
  • string
Properties:
Name Type Argument Description
action string <optional>
The action to perform
actionTopic string <optional>
The topic to re-publish the action request on
Since:
  • 1.0.39
Default Value:
  • "ALF_SELECTED_DOCUMENTS_ACTION_REQUEST"
Source:
Listeners of This Event:

SET_COLUMNS

Use by the AlfGalleryViewSlider to publish changes in the number of columns that should be shown in the AlfGalleryView.
Type:
  • string
Properties:
Name Type Description
value number The number of columns to display.
Since:
  • 1.0.40
Default Value:
  • "ALF_DOCLIST_SET_GALLERY_COLUMNS"
Source:
Listeners of This Event:

SET_THUMBNAIL_SIZE

Use by the ThumbnailSizeSlider to publish changes to the size of the thumbnails that are shown in the AlfGalleryView.
Type:
  • string
Properties:
Name Type Description
value number The size (in pixels) to make the thumbnails.
Since:
  • 1.0.40
Default Value:
  • "ALF_SET_THUMBNAIL_SIZE"
Source:
Listeners of This Event:

SHOW_LIGHTBOX

This topic is subscribed to by the LightboxService in order to handle requests to display lightboxes that show an image preview of a Node.
Type:
  • string
Properties:
Name Type Description
title string The title for the lightbox
src string The location of the image file to show in the lightbox
Since:
  • 1.0.59
Default Value:
  • "ALF_DISPLAY_LIGHTBOX"
Source:

SHOW_NODE_PREVIEW

This topic is subscribed to by the FilePreviewService in order to handle requests to display previews of nodes.
Type:
  • string
Properties:
Name Type Argument Description
node object <optional>
The Node to show the preview for
nodeRef string <optional>
The NodeRef of the Node to show the preview for
Since:
  • 1.0.59
Default Value:
  • "ALF_SHOW_NODE_PREVIEW"
Source:
Listeners of This Event:

SITE_CREATION_REQUEST

This topic can be published to perform the actual creation of a site. Unlike CREATE_SITE this requires a payload that includes the details for the new site (as it performs the actual creation on the Alfresco Repository rather than just showing a site creation dialog).
Type:
  • string
Properties:
Name Type Description
title string The display title of the site
shortName string The unique site identifier
description string The site description
preset string The Surf preset to use for the site
visibility string The visibility of the site ("PUBLIC" or "PRIVATE")
moderated boolean Indicates whether "PUBLIC" sites should have moderated membership
Since:
  • 1.0.55
Default Value:
  • "ALF_SITE_CREATION_REQUEST"
Source:
Listeners of This Event:

SITE_CREATION_SUCCESS

This topic is published in response to SITE_CREATION_REQUEST to indicate that the site creation attempt was successful.
Type:
  • string
Since:
  • 1.0.55
Default Value:
  • "ALF_SITE_CREATION_SUCCESS"
Source:

SITE_EDIT_REQUEST

This topic can be published to perform the actual creation of a site. Unlike CREATE_SITE this requires a payload that includes the details for the new site (as it performs the actual creation on the Alfresco Repository rather than just showing a site creation dialog).
Type:
  • string
Properties:
Name Type Description
title string The display title of the site
shortName string The unique site identifier
description string The site description
visibility string The visibility of the site ("PUBLIC" or "PRIVATE")
moderated boolean Indicates whether "PUBLIC" sites should have moderated membership
Since:
  • 1.0.55
Default Value:
  • "ALF_SITE_EDIT_REQUEST"
Source:

SITE_EDIT_SUCCESS

This topic is published in response to SITE_EDIT_REQUEST to indicate that the site edit attempt was successful.
Type:
  • string
Since:
  • 1.0.55
Default Value:
  • "ALF_SITE_EDIT_SUCCESS"
Source:

SMART_DOWNLOAD

This can be published to request a "smart" download. It is smart because it will determine whether or not to download a single item individually or multiple items as a ZIP.
Type:
  • string
Properties:
Name Type Description
nodes object[] The node or nodes to download.
Since:
  • 1.0.43
Default Value:
  • "ALF_SMART_DOWNLOAD"
Source:
Listeners of This Event:

SORT_LIST

This can be published to request that a list changes the way that its data is sorted.
Type:
  • string
Properties:
Name Type Argument Description
direction string Either "ascending" or "descending"
value string The field to sort on
requester object <optional>
The widget making the request (include to avoid cycling publications).
Since:
  • 1.0.59
Default Value:
  • "ALF_DOCLIST_SORT"
Source:

STICKY_PANEL_CLOSE

This can be called to close the StickyPanel.
Type:
  • string
Since:
  • 1.0.48
Default Value:
  • "ALF_STICKY_PANEL_CLOSE"
Source:
Listeners of This Event:

STICKY_PANEL_CLOSED

This is fired when the StickyPanel has been closed.
Type:
  • string
Since:
  • 1.0.48
Default Value:
  • "ALF_STICKY_PANEL_CLOSED"
Source:
Listeners of This Event:

STICKY_PANEL_DISABLE_CLOSE

This topic can be published to request that the close button on a StickyPanel be disabled.
Type:
  • string
Since:
  • 1.0.54
Default Value:
  • "ALF_STICKY_PANEL_DISABLE_CLOSE"
Source:
Listeners of This Event:

STICKY_PANEL_ENABLE_CLOSE

This topic can be published to request that the close button on a StickyPanel be enabled.
Type:
  • string
Since:
  • 1.0.54
Default Value:
  • "ALF_STICKY_PANEL_ENABLE_CLOSE"
Source:
Listeners of This Event:

STICKY_PANEL_MINIMISE

This can be called to minimise the StickyPanel.
Type:
  • string
Since:
  • 1.0.55
Default Value:
  • "ALF_STICKY_PANEL_MINIMISE"
Source:
Listeners of This Event:

STICKY_PANEL_RESTORE

This can be called to restore the StickyPanel from a minimised state.
Type:
  • string
Since:
  • 1.0.55
Default Value:
  • "ALF_STICKY_PANEL_RESTORE"
Source:
Listeners of This Event:

STICKY_PANEL_SET_TITLE

This can be called to set the title of the StickyPanel.
Type:
  • string
Properties:
Name Type Description
title string The new title to use
Since:
  • 1.0.48
Default Value:
  • "ALF_STICKY_PANEL_SET_TITLE"
Source:
Listeners of This Event:

STOP_XHR_REQUEST

This topic can be used to stop an XHR request that is in progress.
Type:
  • string
Properties:
Name Type Description
requestId string The id of the request to be stopped
Since:
  • 1.0.75
Default Value:
  • "ALF_STOP_XHR_REQUEST"
Source:
Listeners of This Event:

TAG_QUERY

This topic is used to request tags for a node and its descendants. The payload must container either siteId and containerId, or rootNode.
Type:
  • string
Properties:
Name Type Argument Default Description
callback function The function to be called after the query has successfully executed
callbackScope object The scope within which to run the callback function
maxTags int <optional>
100 The maxinum number of tags to retrieve
siteId string <optional>
The site ID
containerId string <optional>
The container ID within the site
rootNode string <optional>
The root node
Since:
  • 1.0.37
Default Value:
  • "ALF_TAG_QUERY"
Source:
Listeners of This Event:

TINYMCE_EDITOR_FOCUSED

This topic is fired when a TinyMCE editor is given focus. This is primarily used for testing purposes.
Type:
  • string
Since:
  • 1.0.46
Default Value:
  • "ALF_TINYMCE_EDITOR_FOCUSED"
Source:

TOGGLE_OFF

A generic topic used by the ToggleStateActions widget for making requests to toggle the widget to the off state. Typically this would be expected to be overridden with a custom topic.
Type:
  • string
Since:
  • 1.0.64
Default Value:
  • "ALF_TOGGLE_OFF"
Source:

TOGGLE_ON

A generic topic used by the ToggleStateActions widget for making requests to toggle the widget to the on state. Typically this would be expected to be overridden with a custom topic.
Type:
  • string
Since:
  • 1.0.64
Default Value:
  • "ALF_TOGGLE_ON"
Source:

TRIGGER_FORM_SUBMISSION

This topic is used by the FormsRuntimeService as a way of allowing other form controls (notably Transitions) to request that the form be published.
Type:
  • string
Since:
  • 1.0.86
Default Value:
  • "ALF_TRIGGER_FORM_SUBMISSION"
Source:

UNFOLLOW_USERS

This topic can be published to request that the current user unfollow the users provided.
Type:
  • string
Properties:
Name Type Description
userNames string[] An array of the userNames of the users to unfollow.
Since:
  • 1.0.86
Default Value:
  • "ALF_UNFOLLOW_USERS"
Source:
Listeners of This Event:

UPDATE_DATA_LIST

This topic can be published to update the title and description of a Data List.
Type:
  • string
Properties:
Name Type Description
nodeRef string The NodeRef of the the Data List to update
title string The new title of the Data List
description string The new description of the Data List
Since:
  • 1.0.85
Default Value:
  • "ALF_UPDATE_DATA_LIST"
Source:
Listeners of This Event:

UPDATE_LIST_SORT_FIELD

This can be published to change the current field being used to sort lists.
Type:
  • string
Properties:
Name Type Argument Description
direction string Either "ascending" or "descending"
label string <optional>
A label that represents the field to be sorted on
sortable boolean <optional>
Whether or not this field can be have the sort direction changed on it
requester object <optional>
The widget making the request (include to avoid cycling publications).
Since:
  • 1.0.59
Default Value:
  • "ALF_DOCLIST_SORT_FIELD_SELECTION"
Source:

UPDATE_PAGE_TITLE

This topic can be used to publish a request to change the title of a page. It is subscribed to by the Title widget and published by the SetTitle widget
Type:
  • string
Properties:
Name Type Argument Description
title string <optional>
The new title for the browser window
browserTitlePrefix string <optional>
The new prefix for the title of the browser window
hideBrowserTitlePrefix boolean <optional>
Indicates whether or not the title prefix should be hidden
Default Value:
  • "ALF_UPDATE_PAGE_TITLE"
Source:
Listeners of This Event:

UPLOAD_CANCELLATION

This topic is published to cancel any file uploads that are currently in progress.
Type:
  • string
Since:
  • 1.0.43
Default Value:
  • "ALF_UPLOAD_DIALOG_CANCEL_CLICK"
Source:
Listeners of This Event:

UPLOAD_COMPLETION_ACKNOWLEDGEMENT

This topic is published when the user acknowledges the completion of uploading files to the repository
Type:
  • string
Since:
  • 1.0.43
Default Value:
  • "ALF_UPLOAD_DIALOG_OK_CLICK"
Source:
Listeners of This Event:

UPLOAD_MODIFY_ITEM

This topic can be published to to request modification of a line-item in the UploadMonitor widget.
Type:
  • string
Properties:
Name Type Description
uploadId String The ID of the upload item to modify. This will be passed by every configured action when it publishes for a specific upload.
action String The desired action, which must be "REMOVE". More actions will be added later.
Since:
  • 1.0.65
Default Value:
  • "ALF_UPLOAD_MODIFY_ITEM"
Source:
Listeners of This Event:

UPLOAD_REQUEST

This topic is published to request an upload.
Type:
  • string
Properties:
Name Type Argument Description
files object[] The files to upload
fileRefs string <optional>
A dot-notation reference to the files in the context of alfGetData which will override any included files
targetData object An object describing where to upload the files to
alfResponseTopic string The topic on which to respond after all files have uploaded (successfully or unsuccessfully)
responseScope string <optional>
The scope of the response defined by the alfResponseTopic, defaults to the scope of the publish caller
Since:
  • 1.0.52
Default Value:
  • "ALF_UPLOAD_REQUEST"
Source:
Listeners of This Event:

VALIDATE_SITE_IDENTIFIER

This topic can be published to request whether or not a particular site identifier (either the title or shortName) has already been used for a site.
Type:
  • string
Properties:
Name Type Argument Description
shortName string <optional>
The shortName to validate
title string <optional>
The title to validate
Since:
  • 1.0.89
Default Value:
  • "ALF_VALIDATE_SITE_IDENTIFIER"
Source:
Listeners of This Event:

VIEW_RENDERING_COMPLETE

This topic is published by an AlfList when a view has completed rendering. It is used by the InfiniteScrollArea as a trigger to check whether or not more data needs to be loaded to fill the area.
Type:
  • string
Since:
  • 1.0.101
Default Value:
  • "ALF_VIEW_RENDERING_COMPLETE"
Source:
Listeners of This Event:

COPY_OR_MOVE

This topic is published to launch the copying or moving of a node (or nodes) to another location.
Type:
  • string
Properties:
Name Type Argument Default Description
documents object[] The nodes/documents to be copied/moved
copy boolean <optional>
false Whether to copy the node(s) - default is to move
singleItemMode boolean <optional>
true The mode in which to launch the picker (to determine single or multiple destinations)
dialogTitle string <optional>
The title of the picker dialog - default is the generic "copy" title
confirmButtonLabel string <optional>
The label of the picker confirmation button - default is the generic "copy" button confirmation
Since:
  • 1.0.36
Source:

DELETE_SITE

This topic is published to request the deletion of a site.
Type:
  • string
Properties:
Name Type Argument Description
redirect object <optional>
The redirect data to use after successfully deleting the site
Properties
Name Type Argument Default Description
url string <optional>
The URL to navigate to
type string <optional>
PAGE_RELATIVE The type of navigation
target string <optional>
CURRENT" Whether to use the current tab ("CURRENT") or open in a new tab ("NEW")
Since:
  • 1.0.35
Source:

DOCUMENT_DESELECTED

Publish this to indicate the de-selection of an individual item
Type:
  • string
Properties:
Name Type Description
value object The item de-selected
Since:
  • 1.0.35
Source:

DOCUMENT_SELECTED

Publish this to indicate the selection of an individual item.
Type:
  • string
Properties:
Name Type Description
value object The item selected
Since:
  • 1.0.35
Source:

DOCUMENT_SELECTION_UPDATE

This can be used to publish bulk changes in document selection. This differs from the DOCUMENT_SELECTED as it is used to make general selection requests, e.g. "selectAll". Alternatively a "selectedItems" attribute can be used to list specific items that should be selected.
Type:
  • string
Properties:
Name Type Argument Default Description
value string <optional>
null The selection type, either "selectAll", "selectNone", "selectInvert", "selectFolders" or "selectDocuments"
selectedItems object[] <optional>
null A specific set of items to be selected
Since:
  • 1.0.35
Source:

GET_PREFERENCE

This topic can be published to request a user preference be returned. It is typically handled by the PreferenceService.
Type:
  • string
Properties:
Name Type Description
preference string Dot-notation property indicating the user preference to retrieve
callback function The function to call when the preference has been retrieved
callbackScope object The scope with which to execute the callback
Since:
  • 1.0.34
Source:

POST_TO_PAGE

This topic can be published to request to POST data to a new page
Type:
  • string
Properties:
Name Type Argument Default Description
url string The URL to navigate to
type string <optional>
PAGE_RELATIVE The type of navigation
target string <optional>
CURRENT" Whether to use the current tab ("CURRENT") or open in a new tab ("NEW")
parameters object <optional>
{} The parameters to include in the POST
Since:
  • 1.0.35
Source:

RELOAD_PAGE

This topic can be published to request to reload the current page
Type:
  • string
Since:
  • 1.0.35
Source:

REQUEST_FINISHED_TOPIC

Published to indicate that list data requests have been completed. Typically used to track whether or not XHR requests for data are in progress.
Type:
  • string
Since:
  • 1.0.36
Source:

SEARCH_REQUEST

This topic can be used to publish a request to perform a search.
Type:
  • string
Properties:
Name Type Argument Description
term string The term to search for
startIndex number <optional>
The index in the search results to start the page of data from
pageSize number <optional>
The number of results to include in the page of data
site string <optional>
The shortName of a site to search within
rootNode string The nodeRef of the node to search within
repo boolean <optional>
Indicates whether or not so search within the entire Alfresco Repository or just sites
facetFields string <optional>
Comma delimited fields to facet on in the search
filters string <optional>
Comma delimited facet filters to apply to the search
spellcheck boolean <optional>
Indicates whether or not to perform alternative searches based on better spelling
query object <optional>
Additinal query parameters to apply to the search
sortField string <optional>
The field to sort the search results on
sortAscending boolean <optional>
Indicates whether or not to sort the search results in ascending order
Since:
  • 1.0.51
Source:

SELECTED_DOCUMENTS_CHANGED

Used to indicate the list of currently selected documents has changed and provides the details of those items.
Type:
  • string
Properties:
Name Type Description
selectedItems object[] The items that are selected
Since:
  • 1.0.35
Source: