|
GData JavaScript Client 1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--google.gdata.When
Describes a period of time.
Defined in gdata.js
Field Summary | |
String|Undefined |
endTime
Event end time. |
String|Undefined |
startTime
Event start time. |
String|Undefined |
valueString
String description of the event times. |
Constructor Summary | |
google.gdata.When(<Object> opt_params)
Constructs a time period description using an object parameter whose property names match the setter method to use for each property. |
Method Summary | |
void
|
addReminder(<google.gdata.Reminder|Object> reminder)
Adds a new event reminder. |
google.gdata.DateTime|Undefined
|
getEndTime()
Returns the event end time. |
Array.<google.gdata.Reminder>
|
getReminder()
Returns the event reminders. |
google.gdata.DateTime|Undefined
|
getStartTime()
Returns the event start time. |
String|Undefined
|
getValueString()
Returns the string description of the event times. |
void
|
setEndTime(<google.gdata.DateTime|Date|Undefined> endTime)
Sets the event end time. |
void
|
setReminder(<Array.<google.gdata.Reminder>|Array.<Object>|Undefined> reminder)
Sets the event reminders. |
void
|
setStartTime(<google.gdata.DateTime|Date|Undefined> startTime)
Sets the event start time. |
void
|
setValueString(<String|Undefined> valueString)
Sets the string description of the event times. |
Field Detail |
String|Undefined endTime
String|Undefined startTime
String|Undefined valueString
Constructor Detail |
google.gdata.When(<Object> opt_params)
opt_params
- Optional parameters, each of which is used as the sole parameter to the associated setter method: endTime, reminder, startTime, and valueString
Method Detail |
void addReminder(<google.gdata.Reminder|Object> reminder)
reminder
- Event reminder to add, or object to use as a parameter to the google.gdata.Reminder constructor
google.gdata.DateTime|Undefined getEndTime()
Array.<google.gdata.Reminder> getReminder()
google.gdata.DateTime|Undefined getStartTime()
String|Undefined getValueString()
void setEndTime(<google.gdata.DateTime|Date|Undefined> endTime)
endTime
- Event end time or undefined for none
void setReminder(<Array.<google.gdata.Reminder>|Array.<Object>|Undefined> reminder)
reminder
- Event reminders, where each event reminder is added using the addReminder() function, or undefined to clear the event reminders
void setStartTime(<google.gdata.DateTime|Date|Undefined> startTime)
startTime
- Event start time or undefined for none
void setValueString(<String|Undefined> valueString)
valueString
- String description of the event times or undefined for none
|
GData JavaScript Client 1.1 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |