CalendarAccessRole Property

The access role that the authenticated user has on the calendar.

Syntax

 gcalendar.getCalendarAccessRole([callback])

Possible Values

  0 (gcacrFreeBusyReader), 
  1 (gcacrReader), 
  2 (gcacrWriter), 
  3 (gcacrOwner)

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 getCalendarAccessRole([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 setCalendarAccessRole([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 returns the access role for the currently authenticated user. This is populated when iterating over results from a call to ListCalendars. Possible values are:

This property is read-only and not available at design time.

Data Type

Integer