EventStatus Property

Contains the status of the event.

Syntax

 gcalendar.getEventStatus([callback])
 gcalendar.setEventStatus( eventStatus, [callback])

Possible Values

  0 (gcsConfirmed), 
  1 (gcsTentative), 
  2 (gcsCanceled)

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 getEventStatus([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 setEventStatus([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 get the status of the event and is populated with EventIndex is set.

This property is not available at design time.

Data Type

Integer