Birthday Property

The Birthday of the current contact in a Google Contacts feed.

Syntax

 gcontacts.getBirthday([callback])
 gcontacts.setBirthday( birthday, [callback])

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 getBirthday([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 setBirthday([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 obtain the Birthday of the specified contact within a Google Contact feed and will be populated once ContactIndex is set.

The returned value will be in the format YYYY-MM-DD or --MM-DD (without a year specified). If the contact does not have a Birthday associated with it, this property will be an empty string.

This property is also used when updating a contact and can be set to the wanted value prior to calling UpdateContact.

This property is not available at design time.

Data Type

String