QueryUserGroups Property

The user groups for the query.

Syntax

 sapquery.getQueryUserGroups([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 getQueryUserGroups([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 setQueryUserGroups([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 is populated with the query's user groups after a call to RetrieveUserGroups. Each user group will be split by a ','. For example:

ZADMINS, ZEMPLOYEES, ZCONTRACTORS

This property is read-only.

Data Type

String