Class Alfresco.module.DoclibActions

Document Library Actions module for Document Library.

Field Summary
Field Attributes	Field Name and Description
	defaultConfig Object literal for default AJAX request configuration
	isReady Flag indicating whether module is ready to be used.

Method Summary
Method Attributes	Method Name and Description
	genericAction() ACTION: Generic action.
	onComponentsLoaded() Fired by YUILoaderHelper when required component script files have
	postActivity(siteId, activityType, page, data) ACTION: Post Activity

Field Detail

{object} defaultConfig

Object literal for default AJAX request configuration

{boolean} isReady

Flag indicating whether module is ready to be used.
Flag is set when all YUI component dependencies have loaded.

Method Detail

{boolean} genericAction()

ACTION: Generic action.
Generic DocLib action based on passed-in parameters

Parameters:

action.success.event.name

{string} Bubbling event to fire on success

action.success.event.obj

{object} Bubbling event success parameter object

action.success.message

{string} Timed message to display on success

action.success.callback.fn

{object} Callback function to call on success.

function(data, obj) where data is an object literal containing config, json, serverResponse

action.success.callback.scope

{object} Success callback function scope

action.success.callback.obj

{object} Success callback function object passed to callback

action.success.activity.siteId

{string} Site associated with activity

action.success.activity.activityType

{string} Activity type to post

action.success.activity.page

{string} Page to generate activity link to

action.success.activity.activityData

{object} Metadata for activity type

action.failure.event.name

{string} Bubbling event to fire on failure

action.failure.event.obj

{object} Bubbling event failure parameter object

action.failure.message

{string} Timed message to display on failure

action.failure.callback.fn

{object} Callback function to call on failure.

function(data, obj) where data is an object literal containing config, json, serverResponse

action.failure.callback.scope

{object} Failure callback function scope

action.failure.callback.obj

{object} Failure callback function object passed to callback

action.webscript.stem

{string} optional webscript URL stem

default: Alfresco.constants.PROXY_URI + "slingshot/doclib/action/"

action.webscript.name

{string} data webscript URL name

action.webscript.method

{string} HTTP method to call the data webscript on

action.webscript.queryString

{string} Optional queryString to append to the webscript URL

action.webscript.params.siteId

{string} current site

action.webscript.params.containerId

{string} component container

action.webscript.params.path

{string} path where file is located

action.webscript.params.file

{string} file to be deleted

action.webscript.params.nodeRef

{string} noderef instead of site, container, path, file

action.wait.message

{string} if set, show a Please wait-style message during the operation

action.config

{object} optional additional request configuration overrides

Returns:: {boolean} false: module not ready

onComponentsLoaded()

Fired by YUILoaderHelper when required component script files have
been loaded into the browser.

postActivity(siteId, activityType, page, data)

ACTION: Post Activity
Posts a Document Library activity

Parameters:
{string} siteId: site
{string} activityType: org.alfresco.documentlibrary.{activityType}
{string} page: page to link to from activity
{object} data: data attached to activity

Classes

Class Alfresco.module.DoclibActions