ACLRole Property
This property contains the role of ScopeValue for a Google Data object and allows you to determine their access rights.
Syntax
gdata.getACLRole(index, [callback]) gdata.setACLRole(index, ACLRole, [callback])
Possible Values
0 (garOwner), 1 (garWriter), 2 (garReader)
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 getACLRole([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 setACLRole([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 contains the role of ACLScopeValue for a Google Data object and allows you to determine their access rights.
Possible values are:
0 (garOwner) | The owner of the document/folder. As an owner you have the ability to modify the ACL feed, delete the document, etc. |
1 (garWriter) | A Collaborator. |
2 (garReader) | A Viewer (equivalent to read-only access). |
The size of the array is controlled by the ACLCount property.
This property is not available at design time.
Data Type
Integer