ACLRuleIndex Property

The index of the current ACL rule.

Syntax

 gcalendar.getACLRuleIndex([callback])
 gcalendar.setACLRuleIndex( ACLRuleIndex, [callback])

Default Value

-1

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 getACLRuleIndex([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 setACLRuleIndex([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 is used to select an ACL rule after call to ListACLRules.

This property takes index values from 0 to ACLRuleCount -1.

Setting ACLRuleIndex to -1 will clear the rules contained by the component and will also reset all the ACL rule related properties.

This property is not available at design time.

Data Type

Integer