ACLRuleRole Property

The role specified for the ACL rule.

Syntax

 gcalendar.getACLRuleRole([callback])
 gcalendar.setACLRuleRole( ACLRuleRole, [callback])

Possible Values

  0 (gcarNone), 
  1 (gcarFreeBusyReader), 
  2 (gcarReader), 
  3 (gcarWriter), 
  4 (gcarOwner)

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 getACLRuleRole([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 setACLRuleRole([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 role of the ACL rule. This may be set when creating or updating a rule. Possible values are:


0 (gcarNone - default)	No access is provided.
1 (gcarFreeBusyReader)	Allows access to free/busy information.
2 (gcarReader)	Provides read-only access to the calendar. Private events are visible but details are hidden.
3 (gcarWriter)	Allows read and write access to the calendar. Private events, including details, are visible.
4 (gcarOwner)	Grants ownership rights without restriction.

This property is not available at design time.

Data Type

Integer