You are here

ScriptNode API

In JavaScript code various parts of the underlying system can be conveniently exposed as objects of type ScriptNode. For example, the companyhome, userhome, document, space, and person objects are best represented as objects of type ScriptNode. The ScriptNode API provides access to properties and methods for manipulating this type of object.

Additional APIs and properties

In addition to the properties shown in the table, the ScriptNode object API also exposes a number of additional properties and APIs which have been grouped by functional purpose in this documentation. These additional APIs include:

Properties

The following properties are available to use within scripts:

Property Read/write Description
activeWorkflows Read-only

Returns an array of all active workflows in which this node is involved. Null is returned if the node is not part of an active workflow.

The following code snippet obtains a list of workflow objects for the file TEST_FILE_0.TXT:

var node = companyhome.childByNamePath("TEST_FILE_0.TXT");
var workflows = node.activeWorkflows;
aspects Read-only A read-only array of the fully qualified QName strings applied to the node
aspectsSet Read-only A list of aspects applied to this node
aspectsShort Read-only An array of aspects as short prefix qnames applied to this node
associations Read-only The same as assocs
assocs Read-only A read-only associative array of the target associations of the node. Each named entry in the array contains an array of the script node objects on the end of the association.

Example: mynode.assocs["cm:translations"][0]

childAssociations Read-only Same as childAssocs
childAssocs Read-only A read-only associative array of the child associations of the node. Each named entry in the array contains an array of the script node objects on the end of the association.

Example: myforumnode.childAssocs["fm:discussion"][0]

children Read-only A read-only JavaScript array of the child node objects

Example: mynode.children[0]

content Read-write The content string for this node from the default content property (ContentModel.PROP_CONTENT).
displayPath Read-only A read-only display path to this node
downloadUrl Read-only For a content document this is a read-only string representing the download (as attachment) URL for the content. For a container node this would be an empty string.
hasChildren Read-only True if the node has children
icon16 Read-only A read-only small icon image for this node
icon32 Read-only A read-only large icon image for this node
id Read-only The GUID for the node
isCategory Read-only Returns true if this node is a category, or false otherwise
isContainer Read-only Returns true if the node is a folder node, or false otherwise
isDocument Read-only Returns true if this node is a document, or false otherwise
isLinkToContainer Read-only Returns true if this node is a link to a container, or false otherwise
isLinkToDocument Read-only Returns true if this node is a link to a document, or false otherwise
isLocked Read-only Returns true if the node is locked, or false otherwise. Once a node is checked out it becomes locked.
mimetype Read-write A read/write value representing the MIME type of the content
name Read-write Shortcut access to the cm:name property. Can be read and written to.
nodeRef Read-only The NodeRef corresponding to this node
parent Read-only Primary parent node. This will be null if this is the root node.
parentAssociations Read-only Same as parentAssocs
parentAssocs Read-only A read-only associative array of the parent associations of the node. Each named entry in the array contains an array of the script node objects on the end of the association.

Example: mynode.parentAssocs["cm:contains"][0]

parents Read-only Array of the parent nodes
primaryParentAssoc Read-only The primary parent association so it is possible to obtain the association QName and the association type QName
properties Read-only Provides access to all the properties of this node. The properties returned are accessed by using an associative array. Properties of a node can be accessed in the following ways:

Example: node.properties["name"]

Example: node.properties.name

qnamePath Read-only A read-only QName type path to this node
qNameType Read-only The QName type
siteShortName Read-only Returns the name of the site this node is contained within. If the node is not contained within a site, the value is null
size Read-only A read-only long value that represents the size (in bytes) of the content attached to the node from the default content property.
sourceAssociations Read-only The same as sourceAssocs
sourceAssocs Read-only A read-only associative array of the source associations of the node. Each named entry in the array contains an array of the script node objects on the end of the association.

Example: mynode.assocs["cm:translations"][0]

storeId Read-only The store id for the node
storeType Read-only The store type for the node
type Read-only Fully qualified QName type of the node
typeShort Read-only Returns the type of the node as a short form qname.
url Read-only For a content document, this method returns the URL to the content stream for the default content property. For a container node, this method returns the URL to browse to the folder in the web-client.
webdavUrl Read-only A read-only string representing the webdav URL for the content

Sending feedback to the Alfresco documentation team

You don't appear to have JavaScript enabled in your browser. With JavaScript enabled, you can provide feedback to us using our simple form. Here are some instructions on how to enable JavaScript in your web browser.