|
GData JavaScript Client 1.8 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.Reminder
Describes a reminder on an event.
Defined in gdata.js
Field Summary | |
{string|undefined} |
absoluteTime
Absolute time of the reminder. |
{string|undefined} |
days
Number of days before the start time. |
{string|undefined} |
hours
Number of hours before the start time. |
{string|undefined} |
method
Method. |
{string|undefined} |
minutes
Number of minute before the start times. |
<static> <final> {string} |
METHOD_ALERT
Causes an alert to appear when a user is viewing the calendar in a browser. |
<static> <final> {string} |
METHOD_ALL
All reminder methods. |
<static> <final> {string} |
METHOD_EMAIL
Sends the user an email message. |
<static> <final> {string} |
METHOD_NONE
No reminder methods. |
<static> <final> {string} |
METHOD_SMS
Sends the user an SMS text message. |
Constructor Summary | |
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. |
Method Summary | |
google.gdata.DateTime|undefined
|
getAbsoluteTime()
Returns the absolute time of the reminder. |
number|undefined
|
getDays()
Returns the number of days before the start time. |
number|undefined
|
getHours()
Returns the number of hours before the start time. |
string|undefined
|
getMethod()
Returns the method. |
number|undefined
|
getMinutes()
Returns the number of minute before the start times. |
void
|
setAbsoluteTime(<google.gdata.DateTime|Date|undefined> absoluteTime)
Sets the absolute time of the reminder. |
void
|
setDays(<number|undefined> days)
Sets the number of days before the start time. |
void
|
setHours(<number|undefined> hours)
Sets the number of hours before the start time. |
void
|
setMethod(<string|undefined> method)
Sets the method. |
void
|
setMinutes(<number|undefined> minutes)
Sets the number of minute before the start times. |
Field Detail |
{string|undefined} absoluteTime
{string|undefined} days
{string|undefined} hours
{string|undefined} method
{string|undefined} minutes
<static> <final> {string} METHOD_ALERT
<static> <final> {string} METHOD_ALL
<static> <final> {string} METHOD_EMAIL
<static> <final> {string} METHOD_NONE
<static> <final> {string} METHOD_SMS
Constructor Detail |
google.gdata.Reminder(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: absoluteTime, days, hours, method, and minutes.
Method Detail |
google.gdata.DateTime|undefined getAbsoluteTime()
number|undefined getDays()
number|undefined getHours()
string|undefined getMethod()
number|undefined getMinutes()
void setAbsoluteTime(<google.gdata.DateTime|Date|undefined> absoluteTime)
absoluteTime
- Absolute time of the reminder or undefined for none.
void setDays(<number|undefined> days)
days
- Number of days before the start time or undefined for none.
void setHours(<number|undefined> hours)
hours
- Number of hours before the start time or undefined for none.
void setMethod(<string|undefined> method)
method
- Method or undefined for none.
void setMinutes(<number|undefined> minutes)
minutes
- Number of minute before the start times or undefined for none.
|
GData JavaScript Client 1.8 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |