Class google.gdata.When

Object
   |
   +--google.gdata.When

class google.gdata.When

Describes a period of time.
Defined in gdata.js

Field Detail

endTime

String|Undefined endTime

Event end time. This attribute is optional.

startTime

String|Undefined startTime

Event start time. This attribute is required.

valueString

String|Undefined valueString

String description of the event times. This attribute is optional.

google.gdata.When

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.

Parameters:
opt_params - Optional parameters, each of which is used as the sole parameter to the associated setter method: endTime, reminder, startTime, and valueString

addReminder

void addReminder(<google.gdata.Reminder|Object> reminder)

Adds a new event reminder.

Parameters:
reminder - Event reminder to add, or object to use as a parameter to the google.gdata.Reminder constructor

getEndTime

google.gdata.DateTime|Undefined getEndTime()

Returns the event end time. This attribute is optional.

Returns:
Event end time or undefined for none

getReminder

Array.<google.gdata.Reminder> getReminder()

Returns the event reminders.

Returns:
Event reminders

getStartTime

google.gdata.DateTime|Undefined getStartTime()

Returns the event start time. This attribute is required.

Returns:
Event start time or undefined for none

getValueString

String|Undefined getValueString()

Returns the string description of the event times. This attribute is optional.

Returns:
String description of the event times or undefined for none

setEndTime

void setEndTime(<google.gdata.DateTime|Date|Undefined> endTime)

Sets the event end time. This attribute is optional.

Parameters:
endTime - Event end time or undefined for none

setReminder

void setReminder(<Array.<google.gdata.Reminder>|Array.<Object>|Undefined> reminder)

Sets the event reminders.

Parameters:
reminder - Event reminders, where each event reminder is added using the addReminder() function, or undefined to clear the event reminders

setStartTime

void setStartTime(<google.gdata.DateTime|Date|Undefined> startTime)

Sets the event start time. This attribute is required.

Parameters:
startTime - Event start time or undefined for none

setValueString

void setValueString(<String|Undefined> valueString)

Sets the string description of the event times. This attribute is optional.

Parameters:
valueString - String description of the event times or undefined for none