ItemURL Property

The URL for the item.

Syntax

 spworkflow.getItemURL([callback])
 spworkflow.setItemURL( itemURL, [callback])

Default Value

""

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getItemURL([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setItemURL([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This specifies the URL of the particular item which will be used for all workflow operations. The ItemURL can be found using the SPList class.

An example of a valid URL is: http://server/Sites/mysite/Shared%20Documents/test.txt

Data Type

String