Class google.gdata.Reminder

Object
   |
   +--google.gdata.Reminder

class google.gdata.Reminder

Describes a reminder on an event.
Defined in gdata.js

Field Detail

absoluteTime

{string|undefined} absoluteTime

Absolute time of the reminder. This attribute is optional.

days

{string|undefined} days

Number of days before the start time. This attribute is optional.

hours

{string|undefined} hours

Number of hours before the start time. This attribute is optional.

method

{string|undefined} method

Method. This attribute is optional.

minutes

{string|undefined} minutes

Number of minute before the start times. This attribute is optional.

METHOD_ALERT

<static> <final> {string} METHOD_ALERT

Causes an alert to appear when a user is viewing the calendar in a browser.

See Also:

Constant Field Values

METHOD_ALL

<static> <final> {string} METHOD_ALL

All reminder methods.

See Also:

Constant Field Values

METHOD_EMAIL

<static> <final> {string} METHOD_EMAIL

Sends the user an email message.

See Also:

Constant Field Values

METHOD_NONE

<static> <final> {string} METHOD_NONE

No reminder methods.

See Also:

Constant Field Values

METHOD_SMS

<static> <final> {string} METHOD_SMS

Sends the user an SMS text message.

See Also:

Constant Field Values

google.gdata.Reminder

google.gdata.Reminder(<Object> opt_params)

Constructs a reminder using an object parameter whose property names match the setter method to use for each property.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: absoluteTime, days, hours, method, and minutes.

getAbsoluteTime

google.gdata.DateTime|undefined getAbsoluteTime()

Returns the absolute time of the reminder. This attribute is optional.

Returns:
Absolute time of the reminder or undefined for none.

getDays

number|undefined getDays()

Returns the number of days before the start time. This attribute is optional.

Returns:
Number of days before the start time or undefined for none.

getHours

number|undefined getHours()

Returns the number of hours before the start time. This attribute is optional.

Returns:
Number of hours before the start time or undefined for none.

getMethod

string|undefined getMethod()

Returns the method. This attribute is optional.

Returns:
Method or undefined for none.

getMinutes

number|undefined getMinutes()

Returns the number of minute before the start times. This attribute is optional.

Returns:
Number of minute before the start times or undefined for none.

setAbsoluteTime

void setAbsoluteTime(<google.gdata.DateTime|Date|undefined> absoluteTime)

Sets the absolute time of the reminder. This attribute is optional.

Parameters:
absoluteTime - Absolute time of the reminder or undefined for none.

setDays

void setDays(<number|undefined> days)

Sets the number of days before the start time. This attribute is optional.

Parameters:
days - Number of days before the start time or undefined for none.

setHours

void setHours(<number|undefined> hours)

Sets the number of hours before the start time. This attribute is optional.

Parameters:
hours - Number of hours before the start time or undefined for none.

setMethod

void setMethod(<string|undefined> method)

Sets the method. This attribute is optional.

Parameters:
method - Method or undefined for none.

setMinutes

void setMinutes(<number|undefined> minutes)

Sets the number of minute before the start times. This attribute is optional.

Parameters:
minutes - Number of minute before the start times or undefined for none.