public class Reminder extends ExtensionPoint implements Extension
The meaning of this set of reminders differs based on whether you are reading or writing feeds. When reading, the set of reminders returned on an event takes into account both defaults on a parent recurring event (when applicable) as well as the user's defaults on calendar. If there are no gd:reminders returned that means the event has absolutely no reminders. "none" or "all" will not apply in this case.
Writing is different because we have to be backwards-compatible (see *) with the old way of setting reminders. For easier analysis we describe all the behaviors defined in the table below. (Notice we only include cases for minutes, as the other cases specified in terms of days/hours/absoluteTime can be converted to this case.)
Notice method is case-sensitive: must be in lowercase!
no method method method= or method=all =none email|sms|alert ____________________________________________________________________________ no gd:rem *no reminder N/A N/A 1 gd:rem *use user's no reminder InvalidEntryException def. settings 1 gd:rem min=0 *use user's no reminder InvalidEntryException def. settings 1 gd:rem min=-1 *no reminder no reminder InvalidEntryException 1 gd:rem min=+n *override with no reminder set exactly one reminder +n for user's on event at +n with given selected method methods multiple gd:rem InvalidEntry- InvalidEntry- copy this set exactly Exception ExceptionHence, to override an event with a set of reminder
Modifier and Type | Class and Description |
---|---|
static class |
Reminder.Method |
ExtensionPoint.CumulativeBlobHandler, ExtensionPoint.ExtensionHandler
Constructor and Description |
---|
Reminder() |
Modifier and Type | Method and Description |
---|---|
void |
generate(XmlWriter w,
ExtensionProfile extProfile)
Generates an XML representation for the extension.
|
DateTime |
getAbsoluteTime() |
java.lang.Integer |
getDays() |
static ExtensionDescription |
getDefaultDescription()
Returns the suggested extension description.
|
XmlParser.ElementHandler |
getHandler(ExtensionProfile extProfile,
java.lang.String namespace,
java.lang.String localName,
org.xml.sax.Attributes attrs)
The default implementation uses the
AttributesHandler to handle
parsing the extension. |
java.lang.Integer |
getHours() |
Reminder.Method |
getMethod() |
java.lang.Integer |
getMinutes() |
void |
setAbsoluteTime(DateTime v) |
void |
setDays(java.lang.Integer v) |
void |
setHours(java.lang.Integer v) |
void |
setMethod(Reminder.Method v) |
void |
setMinutes(java.lang.Integer v) |
addExtension, addRepeatingExtension, declareExtensions, generateCumulativeXmlBlob, getExtension, getExtensions, getRepeatingExtension, getRepeatingExtensions, getXmlBlob, hasExtension, hasRepeatingExtension, parseCumulativeXmlBlob, removeExtension, removeExtension, removeRepeatingExtension, setExtension, setXmlBlob, visit
disableStrictValidation, enableStrictValidation, getExtensionLocalName, getExtensionNamespace, isImmutable, isStrictValidation, setImmutable
public java.lang.Integer getDays()
public void setDays(java.lang.Integer v)
public java.lang.Integer getHours()
public void setHours(java.lang.Integer v)
public java.lang.Integer getMinutes()
public void setMinutes(java.lang.Integer v)
public DateTime getAbsoluteTime()
public void setAbsoluteTime(DateTime v)
public Reminder.Method getMethod()
public void setMethod(Reminder.Method v)
public static ExtensionDescription getDefaultDescription()
public void generate(XmlWriter w, ExtensionProfile extProfile) throws java.io.IOException
Extension
generate
in interface Extension
generate
in class AbstractExtension
w
- XML writerextProfile
- extension profilejava.io.IOException
public XmlParser.ElementHandler getHandler(ExtensionProfile extProfile, java.lang.String namespace, java.lang.String localName, org.xml.sax.Attributes attrs)
AbstractExtension
AttributesHandler
to handle
parsing the extension.getHandler
in interface Extension
getHandler
in class ExtensionPoint
extProfile
- extension profilenamespace
- extension namespacelocalName
- tag name, without the namespace prefixattrs
- tag attributes