Global

Methods

getParentNodeRef(record) → {string|null}

Tries to get a common parent nodeRef for an action that requires one.
Parameters:
Name Type Description
record object Object literal representing one file or folder to be actioned
Source:
Returns:
Parent nodeRef or null
Type
string | null

msg(i18nScope, key) → {*}

Parameters:
Name Type Description
i18nScope
key
Source:
Returns:
Type
*

onSidebarToggle()

Toggle sidebar button click handler
Source:

Type Definitions

Choice

The Choice object (referenced in other JSDoc comments)
Type:
  • object
Properties:
Name Type Description
domNode object The main domNode for the choice
contentNode object The content domNode inside the choice
closeButton object The domNode of the close button
selectListener object A remove handle for the choice selection listener
closeListener object A remove handle for the close-button listener
item object The store item
value string The value of this choice
Source:

createCopyMoveDialogConfig

Create a typeDef for the createCopyMoveDialogConfig type used by alfresco/services/ActionService:createCopyMoveDialog
Type:
  • Object
Properties:
Name Type Argument Description
urlPrefix String <optional>
The URL prefix for the action
dialogTitle string <optional>
The title for the dialog
confirmButtonLabel String <optional>
The label for the confirmation button
singleItemMode Bool <optional>
alfresco/pickers/PickedItems:singleItemMode
Source:

Dimensions

Type:
  • object
Properties:
Name Type Description
width number The width property
height number The height property
Source:

File

The File object (referenced in other JSDoc comments)
Type:
  • object
Properties:
Name Type Description
progress num The current upload-progress as a percentage
fileName string The name of the file
nodeRef string The nodeRef that this file was uploaded to (if successful)
request object The request object used to upload the file
state num The state as per FileUploadService.state
uploadData object Information pertaining to the upload itself (see constructUploadData)
_dfd object An internal deferred object that is auto-generated and will resolve once the upload has finished (successfully or unsuccessfully)
Source:

Label

The Label object (referenced in other JSDoc comments)
Type:
  • object
Properties:
Name Type Description
choice string The version of the label used for chosen items
result string The version of the label used for items in the results dropdown
full string The full version of the label, used as the title attribute for choices and results
Source:

logPayload

Type:
  • Object
Properties:
Name Type Description
severity string
callerName string
messageArgs Object[]
Source:

payloadConfig

The payload config object
Type:
  • object
Properties:
Name Type Description
maxDepth number The maximum depth of included objects
maxChildren number The maximum number of child properties to include on a single object
excludedKeys string[] Property names which should not have their values included
Source:

Result

The Result object (referenced in other JSDoc comments)
Type:
  • object
Properties:
Name Type Description
domNode object The main domNode for the result
item object The store item
value string The value of this choice
Source:

Rules

The Rules object (as used in evaluateRules).

The value under test (test-value) is retrieved from the "testObject" property using the path defined in "attribute". The rules are then evaluated as follows:

  • If neither "is" nor "isNot" are specified then the test-value is valid and the success callback will be executed
  • If only "is" is provided then the success callback will be executed if the test-value is within the "is" values
  • If only "isNot" is provided then the success callback will be executed if the test-value is not within the "isNot" values
  • If both "is" and "isNot" are provided then the test-value must NOT be in the "isNot" values. If that test passes then it will then be checked to ensure it is present in the "is" values. If both these tests pass then the success callback will be executed
  • The failure callback is NOT normally executed. In order for it to execute, the test-value must be invalid according to the above rules and the "strict" flag should be set to true
  • If the "negate" flag is set to true then it will directly inverse the above logic. If a success callback would have been executed then a failure callback will now be, and vice versa
Type:
  • object
Properties:
Name Type Argument Default Description
attribute string The dot-notation path to the value retrieve from the object under test
testObject object The object under test
lookupObject object <optional>
If this is supplied then treat the values contained in the rules as paths to the true comparison value within this lookupObject
is * <optional>
The tested value MUST be equal to at least one of these values if provided (must be array)
isNot * <optional>
The tested value must NOT be equal to any of these values if provided (must be array)
negate boolean <optional>
Invert the final result
strict boolean <optional>
See description above
useLegacyProcessing boolean <optional>
true Use the legacy algorithms for evaluating matches
Source:

serviceXhrConfig

This method handles XHR requests. As well as providing default callback handlers for the success, failure and progress responses it also performs some additional JSON cleanup of responses (where required) which is useful when REST APIs return invalid code (this is especially useful as Dojo can be quite particular about parsing JSON). The function takes a single object as an argument that will allow updates to be made to include additional data and provide defaults when it is not provided. By default this function will issue a POST method
Type:
  • Object
Properties:
Name Type Argument Default Description
url String Where should we send the request to.
headers Object <optional>
headers - Request headers to send (replaces the default headers if specified)
data Object <optional>
null data for the request body
doNotCleanData boolean <optional>
false Pass true to SUPPRESS cleaning of the "data" object to remove framework attributes from it.
query String <optional>
null data for the query string
handleAs String <optional>
text TODO - document this feature.
method String <optional>
POST HTTP method to use for XHR
requestId Object <optional>
TODO - document this feature
successCallback function <optional>
overrides the default success callback
failureCallback function <optional>
overrides the default failure callback
progressCallback function <optional>
overrides the default progress callback
authenticationFailureCallback function <optional>
overrides the default authentication failure behaviour
callbackScope function <optional>
_this the scope to pass to the overridden callback function
alfTopic string <optional>
The topic to by published by the default request callbacks.
alfResponseScope string <optional>
"" The scope to use when publishing in the default request callbacks. Appended with "_PROGRESS", "_FAILURE" or "_SUCCESS" depending on response status code.
Support:
  • This function is safe to call by extending or mixing modules (at least until the next major release).
Source:

SortFieldOption

Type:
  • object
Properties:
Name Type Argument Default Description
propName id <optional>
null An to give the menu item for the option
label string The label to render for the option
value string The value of the option
selected boolean <optional>
false Indicates whether or not the option should be initially selected
direction string <optional>
null The direction to sort in when the option is used (either "ascending" or "descending").
Source:

Events

additionalViewControlsTopic

The topic to publish on when a view is selected that provides additional controls
Type:
  • string
Source:

alfLoggingTopic

Type:
  • string
Source:
Listeners of This Event:

docsPerpageSelectionTopic

This topic is used to publish changes of the number of documents to show for each page.
Type:
  • string
Source:
Listeners of This Event:

documentLoadFailedTopic

This topic is used to indicate that documents could not be loaded.
Type:
  • string
Source:

documentsLoadedTopic

This topic is used to publish the details of documents loaded for the current location.
Type:
  • string
Source:
Listeners of This Event:

dynamicallyAddWidgetTopic

This topic is used to publish a request to add a widget dynamically to a previously processed widget container.
Type:
  • string
Source:

eventsResizeTopic

This topic is used to subscribe to rate limited resize events.
Type:
  • String
Source:

eventsScrollTopic

This topic is used to subscribe to rate limited scroll events.
Type:
  • String
Source:
Listeners of This Event:

filterSelectionTopic

This differs from the "hashChangeTopic" because it describes the "filter" filter (as opposed to a "path" filter) rather than just indicating that the current filter has been changed. This is required so that widgets can reflect information about the currently selected filter - for example, a breadcrumb trail needs to show information about the selected filter.
Type:
  • string
Source:
Listeners of This Event:

hashChangeTopic

Type:
  • string
Source:
Listeners of This Event:

loadMoreDataTopic

Used to indicate more data is required, as we're at the end of the current data
Type:
  • string
Since:
  • 1.0.32
Default Value:
Source:

metadataChangeTopic

This topic is used to publish changes to the current displayed parent location. It should be used to provide all the metdata for rendering the current view of documents.
Type:
  • string
Source:

pageSelectionTopic

This topic is used to publish changes of page within the current location.
Type:
  • string
Source:

reloadDataTopic

This topic is used to request that the Document List reloads data using its current parameters.
Type:
  • string
Source:

requestFinishedTopic

Indicates that a document request finished. Usually used in conjunction with requestInProgressTopic. e.g. by code to prevent duplicate submission of requests.
Type:
  • string
Default Value:
  • topics.REQUEST_FINISHED_TOPIC
Source:
Listeners of This Event:

requestInProgressTopic

Indicates that a document request has started. Usually used in conjunction with requestFinishedTopic. e.g. by code to prevent duplicate submission of requests.
Type:
  • string
Source:

scrollNearBottom

Used by infinite scroll to let other widgets know that the bottom of the page has been reached.
Type:
  • string
Default Value:
Source:

scrollReturn

Used to let infinite scroll know we're finished and it can trigger again.
Type:
  • string
Source:
Listeners of This Event:

selectionMenuItemTopic

This is the topic on which the valid registered views will publish the menu items that can be used to select them (the view). A default is provided but can be overridden.
Type:
  • string
Source:

showFoldersTopic

Type:
  • string
Source:

showPathTopic

Used to indicate whether or not to display the current path rendered within the document list.
Type:
  • string
Source:

showSidebarTopic

Indicates whether or not to display a sidebar to accompany the document list (this may contain additional controls such as trees, filters, etc).
Type:
  • string
Source:

singleDocumentActionTopic

Used to request an action on an individual document (as opposed to a group of documents).
Type:
  • string
Source:

sortFieldSelectionTopic

Type:
  • string
Default Value:
  • UPDATE_LIST_SORT_FIELD
Source:

sortFieldSelectionTopic

Type:
  • string
Since:
  • 1.0.102
Default Value:
  • UPDATE_LIST_SORT_FIELD
Source:

sortRequestTopic

Type:
  • string
Default Value:
  • SORT_LIST
Source:

sortRequestTopic

Type:
  • string
Since:
  • 1.0.102
Default Value:
  • SORT_LIST
Source:

sortRequestTopic

Type:
  • string
Since:
  • 1.0.102
Default Value:
  • SORT_LIST
Source:

syncLocationTopic

Type:
  • string
Source:

unsyncLocationTopic

Type:
  • string
Source:

userAccessChangeTopic

This topic is used to publish changes for the users access rights to the current location, e.g. if they no longer have creation rights.
Type:
  • string
Source:

viewSelectionMenuItemGroup

The name of the group into which to place all view selection menu items.
Type:
  • string
Source:

viewSelectionTopic

Type:
  • string
Source: