Reminder

Class Overview

GData schema extension describing a reminder on an event. You can represent a set of reminders where each has a (1) reminder period and (2) notification method. The method can be either "sms", "email", "alert", "none", "all".

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      Exception
 

Summary

[Expand] Inherited Fields
From class com.google.gdata.data.ExtensionPoint private final Collection<Extension> extensions private ExtensionManifest manifest Manifest for this instance. private Map<Class<? extends Extension>, Extension> nonRepeatingExtensionMap Collection of non-repeating extensions. private Map<Class<? extends Extension>, List<Extension>> repeatingExtensionMap Collection of repeating extensions. private final Collection<Extension> repeatingExtensions protected XmlBlob xmlBlob Arbitrary XML (unrecognized extensions).
From class com.google.gdata.data.AbstractExtension private final String extensionLocalName private final XmlNamespace extensionNamespace private boolean immutable Indicates that the extension is constant after construction (false by default). protected final String localName XML local name for this extension or null if not defined protected final XmlNamespace namespace XML namespace for this extension or null if not defined private static ThreadLocal<Boolean> strictValidation Indicates if strict XML parsing/generation validation enabled/disabled

[Expand] Inherited Methods
From class com.google.gdata.data.ExtensionPoint boolean addExtension(Extension ext, Class<? extends Extension> extClass) Internal helper method. void addExtension(Extension ext) Adds an extension object. void addRepeatingExtension(Extension ext) Adds a repeating extension object. void addRepeatingExtension(Extension ext, Class<? extends Extension> extClass) Internal helper method. void checkRequiredExtensions(ExtensionManifest profManifest) Checks whether all required extensions are present. static <T extends Extension> T createExtensionInstance(Class<T> extClass) Creates an instance of the given extension class. void declareExtensions(ExtensionProfile extProfile) Declares the set of expected Extension types for an ExtensionPoint within the target extension profile. void generate(XmlWriter w, ExtensionProfile p, XmlNamespace namespace, String localName, List<XmlWriter.Attribute> attrs, AttributeGenerator generator) Generates the XML into the XML writer. XmlBlob generateCumulativeXmlBlob(ExtensionProfile extProfile) Generates an XML blob containing all recognized and unrecognized extensions. void generateExtensions(XmlWriter w, ExtensionProfile extProfile) Generates XML corresponding to extended properties. void generateStartElement(XmlWriter w, XmlNamespace namespace, String elementName, Collection<XmlWriter.Attribute> additionalAttrs, Collection<XmlNamespace> additionalNs) Generates XML corresponding to the type implementing ExtensionPoint. <T extends Extension> T getExtension(Class<T> extensionClass) Retrieves a non-repeating extension or null if not present. ExtensionDescription getExtensionDescription(ExtensionProfile extProfile, Class<? extends ExtensionPoint> extPoint, String namespaceUri, String localName) Returns the extension description for the namespace URI and local name for the XML element based on the extension point in the extension profile. XmlParser.ElementHandler getExtensionHandler(ExtensionProfile extProfile, Class<? extends ExtensionPoint> extPoint, String namespaceUri, String localName, Attributes attrs) XML parser callback for extended properties. Collection<Extension> getExtensions() Returns an unmodifiable collection of non-repeating extensions in this ExtensionPoint. XmlParser.ElementHandler getHandler(ExtensionProfile p, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension. ExtensionManifest getManifest(ExtensionProfile extProfile, Class<? extends ExtensionPoint> extendedClass) Retrieves the manifest for the specified class. <T extends Extension> List<T> getRepeatingExtension(Class<T> extensionClass) Retrieves a repeating extension list (an empty list if not present). Collection<List<Extension>> getRepeatingExtensions() Returns an unmodifiable collection of lists of repeating extensions in this ExtensionPoint. XmlBlob getXmlBlob() Retrieves the XML blob containing arbitrary (unrecognized) extensions. final <T extends Extension> boolean hasExtension(Class<T> extensionClass) Returns whether the non-repeating extension is present. final <T extends Extension> boolean hasRepeatingExtension(Class<T> extensionClass) Returns whether the repeating extension is present. void initializeArbitraryXml(ExtensionProfile profile, Class<? extends ExtensionPoint> extPoint, XmlParser.ElementHandler handler) Initializes parser handler's XML blob state. void parseCumulativeXmlBlob(XmlBlob blob, ExtensionProfile extProfile, Class<? extends ExtensionPoint> extendedClass) Reverses generateCumulativeXmlBlob(ExtensionProfile). void removeExtension(Extension ext) Removes an extension object. void removeExtension(Class<? extends Extension> extensionClass) Removes an extension object based on its class. void removeRepeatingExtension(Extension ext) Removes a repeating extension object. void setExtension(Extension ext) Sets an extension object. <T extends Extension> void setRepeatingExtension(Class<T> extensionClass, List<T> value) void setXmlBlob(XmlBlob xmlBlob) Sets the XML blob containing arbitrary (unrecognized) extensions. void visit(ExtensionVisitor ev, ExtensionPoint parent) Visits the tree of extension data associated with this extension point instance using the specified ExtensionVisitor, starting at this extension point. void visitChild(ExtensionVisitor ev, Extension child) Called to visit a child of this extension point. void visitChildren(ExtensionVisitor ev) Called to visit all children of this extension point.
From class com.google.gdata.data.AbstractExtension void consumeAttributes(AttributeHelper helper) Consumes attributes from the attribute helper. final static void disableStrictValidation() final static void enableStrictValidation() static boolean eq(Object o1, Object o2) void generate(XmlWriter w, ExtensionProfile p) Generates an XML representation for the extension. void generate(XmlWriter w, ExtensionProfile p, XmlNamespace namespace, String localName, List<XmlWriter.Attribute> attrs, AttributeGenerator generator) Generates the XML into the XML writer. void generateAttributes(List<XmlWriter.Attribute> attrs, AttributeGenerator generator) Generates the attributes in the generator into the list of attributes. final String getExtensionLocalName() Gets the extension's localname. final XmlNamespace getExtensionNamespace() Gets the extension's namespace. XmlParser.ElementHandler getHandler(ExtensionProfile p, String namespace, String localName, Attributes attrs) The default implementation uses the AbstractExtension.AttributesHandler to handle parsing the extension. final boolean isImmutable() final static boolean isStrictValidation() void putAttributes(AttributeGenerator generator) Puts attributes into the attribute generator. boolean sameClassAs(Object o) final void setImmutable(boolean isImmutable) final static void throwExceptionForMissingAttribute(String attrName) Throws an IllegalStateException if the value is required and it is missing. final void throwExceptionIfImmutable() Throws an IllegalStateException if this instance is immutable. void validate() Checks the attributes to see if there are any problems.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface com.google.gdata.data.Extension abstract void generate(XmlWriter w, ExtensionProfile extProfile) Generates an XML representation for the extension. abstract XmlParser.ElementHandler getHandler(ExtensionProfile extProfile, String namespace, String localName, Attributes attrs) Gets an XML element handler for the extension.