ACLRuleScopeType Property

The scope type of the rule.

Syntax

 gcalendar.getACLRuleScopeType([callback])
 gcalendar.setACLRuleScopeType( ACLRuleScopeType, [callback])

Possible Values

  0 (gcastDefault), 
  1 (gcastUser), 
  2 (gcastGroup), 
  3 (gcastDomain)

Default Value

0

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 getACLRuleScopeType([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 setACLRuleScopeType([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 property defines the type of scope for the rule.

When creating a rule this value is used to define the type of the scope of the rule. Possible values are:

This is used in conjunction with ACLRuleScopeValue.

This property is not available at design time.

Data Type

Integer