Logo Search packages:      
Sourcecode: gdata-sharp version File versions  Download package

Google::GData::Calendar::EventEntry Class Reference

Inheritance diagram for Google::GData::Calendar::EventEntry:

Google::GData::Client::AbstractEntry Google::GData::Client::AtomEntry Google::GData::Client::ISupportsEtag Google::GData::Client::AtomBase Google::GData::Client::IExtensionContainer Google::GData::Client::IVersionAware

List of all members.


Detailed Description

Entry API customization class for defining entries in an Event feed.

Definition at line 136 of file evententry.cs.


Public Member Functions

void AddExtension (IExtensionElementFactory factory)
 adding an extension factory for extension elements
override AtomBase CreateAtomSubElement (XmlReader reader, AtomFeedParser parser)
 this is the subclassing method for AtomBase derived classes to overload what childelements should be created needed to create CustomLink type objects, like WebContentLink etc
IExtensionElementFactory CreateExtension (string localName, string ns)
 Creates an extension for a given name and namespace by walking the extension factories list and calling CreateInstance for the right one.
void Delete ()
 deletes the item from the server
int DeleteExtensions (string localName, string ns)
 Delete's all Extensions from the Extension list that match a localName and a Namespace.
 EventEntry (string title, string description, string location)
 Constructs a new EventEntry instance with provided data.
 EventEntry (string title, string description)
 Constructs a new EventEntry instance with provided data.
 EventEntry (string title)
 Constructs a new EventEntry instance with provided data.
 EventEntry ()
 Constructs a new EventEntry instance with the appropriate category to indicate that it is an event.
IExtensionElementFactory FindExtension (string localName, string ns)
 Finds a specific ExtensionElement based on it's local name and it's namespace. If namespace is NULL, the first one where the localname matches is found. If there are extensionelements that do not implment ExtensionElementFactory, they will not be taken into account Primary use of this is to find XML nodes.
IExtensionElementFactory FindExtensionFactory (string localName, string ns)
 Finds the extension factory for a given name/namespace.
ExtensionList FindExtensions (string localName, string ns, ExtensionList arr)
 Finds all ExtensionElement based on it's local name and it's namespace. If namespace is NULL, allwhere the localname matches is found. If there are extensionelements that do not implment ExtensionElementFactory, they will not be taken into account Primary use of this is to find XML nodes.
ExtensionList FindExtensions (string localName, string ns)
 Finds all ExtensionElement based on it's local name and it's namespace. If namespace is NULL, allwhere the localname matches is found. If there are extensionelements that do not implment ExtensionElementFactory, they will not be taken into account Primary use of this is to find XML nodes.
List< TFindExtensions< T > (string localName, string ns)
 Finds all ExtensionElement based on it's local name and it's namespace. If namespace is NULL, allwhere the localname matches is found. If there are extensionelements that do not implment ExtensionElementFactory, they will not be taken into account Primary use of this is to find XML nodes.
string GetAbsoluteUri (string part)
 Read only accessor for AbsoluteUri. This is pushed down whenever a base changes.
string GetExtensionValue (string extension, string ns)
 we have one string based getter usage is: entry.getExtensionValue("namespace", "tagname") to get the elements value
bool IsDirty ()
 returns if the element or one subelement is dirty
bool IsPersistable ()
 checks if the element or one subelement are persistable
virtual void Parse (ExtensionElementEventArgs e, AtomFeedParser parser)
 Parses the inner state of the element.
void ReplaceExtension (string localName, string ns, IExtensionElementFactory obj)
 all extension elements that match a namespace/localname given will be removed and the new one will be inserted
int ReplaceExtensions (ExtensionList newList)
 all extension elements that match a namespace/localname given will be removed and replaced with the new ones. the input array can contain several different namespace/localname combinations if the passed list is NULL or empty, this will just result in additions
void SaveToXml (XmlWriter writer)
 saves the object as XML
void SaveToXml (Stream stream)
 Saves the object as XML.
SimpleElement SetExtensionValue (string extension, string ns, string newValue)
 we have one string based setter usage is: entry.setExtensionValue("tagname", "ns", "value") to set the element this will create the extension if it's not there note, you can ofcourse, just get an existing one and work with that object:
virtual bool ShouldBePersisted ()
 Method to check whether object should be saved. This doesn't check whether the object is dirty; it only checks whether the XML content is worth saving.
void ToggleCategory (AtomCategory cat, bool value)
 helper to toggle categories
AtomEntry Update ()
 commits the item to the server
override bool WalkTree (IBaseWalkerAction action)
 calls the action on this object and all children

Static Public Member Functions

static AtomEntry ImportFromFeed (AtomEntry entryToImport)
 helper method to create a new, decoupled entry based on a feedEntry

Static Public Attributes

static AtomCategory EVENT_CATEGORY
 Category used to label entries that contain Event extension data.

Protected Member Functions

override void AddOtherNamespaces (XmlWriter writer)
 base implementation, as with the abstract feed, we are adding the gnamespace
void CopyEntry (AtomEntry updatedEntry)
 takes the updated entry returned and sets the properties to this object
When GetFirstReminder ()
 returns the first reminder of the Times collection
virtual void OnVersionInfoChanged ()
 this potential overloaded method get's called when the version information of an object is changed. It handles setting the versioninformation on all children and the factories.
override void SaveInnerXml (XmlWriter writer)
 saves the inner state of the element
virtual void SaveXmlAttributes (XmlWriter writer)
 protected virtual int SaveXmlAttributes(XmlWriter writer)
override bool SkipNode (XmlNode node)
 Checks if this is a namespace declaration that we already added.

Static Protected Member Functions

static void WriteElementStart (XmlWriter writer, string elementName)
 protected WriteElementStart(XmlWriter writer)
static void WriteEncodedAttributeString (XmlWriter writer, string attributeName, string content)
 helper method to encapsulate encoding, uses HTML encoding now
static void WriteEncodedAttributeString (XmlWriter writer, string attributeName, AtomUri content)
 helper method to encapsulate encoding, uses HTML encoding now
static void WriteEncodedElementString (XmlWriter writer, string elementName, AtomUri content)
 helper method to encapsulate encoding, uses HTML encoding now
static void WriteEncodedElementString (XmlWriter writer, string elementName, string content)
 helper method to encapsulate encoding, uses HTML encoding now
static void WriteEncodedString (XmlWriter writer, AtomUri content)
 helper method to encapsulate a string encoding, uses HTML encoding now
static void WriteEncodedString (XmlWriter writer, string content)
 helper method to encapsulate a string encoding, uses HTML encoding now
static void WriteLocalDateTimeElement (XmlWriter writer, string elementName, DateTime dateTime)
 Writes out a LOCAL datetime in ISO 8601 format.

Properties

AtomUri AlternateUri [get, set]
 accessor to find the alternate link, in HTML only The method scans the link collection for a link that is of type rel=alternate and has a media type of HTML, otherwise it return NULL. The same is true for setting this. If you need to use a rel/alternate with a different media type, you need to use the links collection directly
AppControl AppControl [get, set]
 returns the app:control element
AtomPersonCollection Authors [get]
 accessor method public Contributors AtomPersonCollection
AtomUri Base [get, set]
 calculates or set's the base uri of an element
GDataBatchEntryData BatchData [get, set]
 accessor to the batchdata for the entry
AtomCategoryCollection Categories [get]
 holds an array of AtomCategory objects
Comments Comments [get, set]
 property accessor for the Comments
AtomContent Content [get, set]
 accessor method public string Content
AtomPersonCollection Contributors [get]
 accessor method public Contributors AtomPersonCollection
bool Dirty [get, set]
 The dirty property - indicates if exactly this element is dirty.
AppEdited Edited [get, set]
 returns the app:edited element of the entry, if any. This is a protocol version 2 feature
AtomUri EditUri [get, set]
 accessor method public Uri EditUri
string Etag [get, set]
 returns this entries etag, if any This is a protocol version 2 feature
string EventId [get]
 as eventId is a commonly used part in the calendar world, we expose it here. In general the EventId is the last part of the AtomId
Transparency EventTransparency [get, set]
 property accessor for the EventTransparency
Visibility EventVisibility [get, set]
 property accessor for the Event Visibility
ExtensionList ExtensionElements [get]
 read only accessor for the ExtensionsElements Collections
ExtensionList ExtensionFactories [get]
 read only accessor for the Extension Factories
AtomFeed Feed [get]
 Read only accessor for feed.
string FeedUri [get, set]
 accessor method public string Feed
AtomId Id [get, set]
 accessor method public AtomId Id
AtomUri ImpliedBase [get, set]
 property that holds the implied base URI
bool IsDraft [get, set]
 specifies if app:control/app:draft is yes or no. this is determined by walking the extension elements collection
string Language [get, set]
 returns and sets the xml:lang value
AtomLinkCollection Links [get]
 accessor method public Links AtomLinkCollection
ExtensionCollection< WhereLocations [get]
 property accessor for the WhereCollection
MediaSource MediaSource [get, set]
 access the associated media element. Note, that setting this WILL cause subsequent updates to be done using MIME multipart posts
AtomUri MediaUri [get, set]
 accessor to find the edit-media link
bool Notifications [get, set]
 property accessor for the Eventnotifications set this to True for notfications to be send
OriginalEvent OriginalEvent [get, set]
 property accessor for the OriginalEvent
ExtensionCollection< WhoParticipants [get]
 property accessor for the whos in the event
int ProtocolMajor [get, set]
 returns the major protocol version number this element is working against.
int ProtocolMinor [get, set]
 returns the minor protocol version number this element is working against.
DateTime Published [get, set]
 accessor method public DateTime PublicationDate
bool QuickAdd [get, set]
 property accessor QuickAdd To create an event using Google Calendar's quick add feature, set the event entry's content to the quick add string you'd like to use. Then add a gCal:quickadd element with a value attribute set to true
bool ReadOnly [get]
 returns whether or not the entry is read-only
Recurrence Recurrence [get, set]
 property accessor for the Recurrence
RecurrenceException RecurrenceException [get, set]
 property accessor for the RecurrenceException
Reminder Reminder [get, set]
 returns the FIRST reminder for backwards compatibility if set, will REMOVE all reminders, but this one (array of one)
ExtensionCollection< ReminderReminders [get]
 property accessor for the Reminder
AtomTextConstruct Rights [get, set]
 accessor method public string rights
AtomUri SelfUri [get, set]
 accessor for the self URI
GCalSequence Sequence [get, set]
IService Service [get, set]
 accessor method for the GData Service to use
AtomSource Source [get, set]
 if the entry was copied, represents the source
EventStatus Status [get, set]
 property accessor for the EventStatus
AtomTextConstruct Summary [get, set]
 accessor method public string Summary
GCalSyncEvent SyncEvent [get, set]
 property accessor for the SyncEvent element
ExtensionCollection< WhenTimes [get]
 property accessor for the WhenCollection
AtomTextConstruct Title [get, set]
 accessor method public AtomTextConstruct Title
GCalUid Uid [get, set]
 property accessor for the uid element
DateTime Updated [get, set]
 accessor method public DateTime UpdateDate
WebContentLink WebContentLink [get, set]
 Property to retrieve/set an associated WebContentLink.
override string XmlName [get]
 Returns the constant representing this XML element.

Private Member Functions

void addEventEntryExtensions ()
 helper method to add extensions to the evententry

Private Attributes

ExtensionCollection< Wherelocations
ExtensionCollection< Whoparticipants
ExtensionCollection< Whentimes

Classes

class  EventStatus
 Constructs a new EventStatus instance. More...
class  QuickAddElement
class  SendNotifications
 indicates if an eventupdate should reissue notifications false by default More...
class  Transparency
 the Transparency of an event class More...
class  Visibility
 Visibility class indicates the visibility of an eventNode. More...

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index