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

Google::GData::Client::AtomFeed Class Reference

Inheritance diagram for Google::GData::Client::AtomFeed:

Google::GData::Client::AtomSource Google::GData::Client::AtomBase Google::GData::Client::IExtensionContainer Google::GData::Client::IVersionAware Google::GData::Client::AbstractFeed Google::GData::GoogleBase::GBaseFeed Google::GData::AccessControl::AclFeed Google::GData::Apps::AppsExtendedFeed Google::GData::Apps::EmailListFeed Google::GData::Apps::EmailListRecipientFeed Google::GData::Apps::GoogleMailSettings::GoogleMailSettingsFeed Google::GData::Apps::Migration::MailItemFeed Google::GData::Apps::NicknameFeed Google::GData::Apps::UserFeed Google::GData::Blogger::BloggerFeed Google::GData::Calendar::CalendarFeed Google::GData::Calendar::EventFeed Google::GData::CodeSearch::CodeSearchFeed Google::GData::Contacts::ContactsFeed Google::GData::Contacts::GroupsFeed Google::GData::Documents::DocumentsFeed Google::GData::Health::HealthFeed Google::GData::Photos::PicasaFeed Google::GData::Spreadsheets::CellFeed Google::GData::Spreadsheets::ListFeed Google::GData::Spreadsheets::SpreadsheetFeed Google::GData::Spreadsheets::WorksheetFeed Google::GData::YouTube::ActivitiesFeed Google::GData::YouTube::YouTubeFeed

List of all members.


Detailed Description

Base class to read gData feeds in Atom.

Version 1.0 changed to:

        AtomFeed =
           element atom:feed {
              atomCommonAttributes,
              (atomAuthor*
               atomCategory*
               atomContributor*
               atomGenerator?
               atomIcon?
               atomId
               atomLink*
               atomLogo?
               atomRights?
               atomSubtitle?
               atomTitle
               atomUpdated
               extensionElement*),
              atomEntry*
           }
In addition it holds:

In addition to these OpenSearch tags, the response also includes the following Atom and gData tags:

Definition at line 127 of file atomfeed.cs.


Public Member Functions

void AddExtension (IExtensionElementFactory factory)
 adding an extension factory for extension elements
 AtomFeed (AtomFeed originalFeed)
 default constructor
 AtomFeed (Uri uriBase, IService service)
 default constructor
virtual 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
AtomFeed CreateBatchFeed (GDataBatchOperationType defaultOperation)
 returns a new batchfeed with all the currently dirty entries in it
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.
int DeleteExtensions (string localName, string ns)
 Delete's all Extensions from the Extension list that match a localName and a Namespace.
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.
TEntry Insert< TEntry > (TEntry newEntry)
 uses the set service to insert a new entry.
bool IsDirty ()
 returns if the element or one subelement is dirty
bool IsPersistable ()
 checks if the element or one subelement are persistable
void Parse (Stream stream, AlternativeFormat format)
 given a stream, parses it to construct the Feed object out of it
virtual void Publish ()
 goes over all entries, and updates the ones that are dirty
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.
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.
override bool WalkTree (IBaseWalkerAction action)
 calls the action on this object and all children

Static Public Member Functions

static bool IsFeedIdentical (AtomFeed feedOne, AtomFeed feedTwo)
 tries to determine if the two feeds derive from the same source

Protected Member Functions

override void AddOtherNamespaces (XmlWriter writer)
 checks to see if we are a batch feed, if so, adds the batchNS
virtual void HandleExtensionElements (ExtensionElementEventArgs e, AtomFeedParser parser)
 event on the Feed to handle extension elements during parsing
void OnNewExtensionElement (object sender, ExtensionElementEventArgs e)
 Event chaining. We catch this by the baseFeedParsers, which would not do anything with the gathered data. We pass the event up to the user; if the user doesn't discard it, we add the entry to our collection.
void OnNewExtensionsElement (object sender, ExtensionElementEventArgs e)
 eventhandler - called for event extension element
void OnParsedNewEntry (object sender, FeedParserEventArgs e)
 Event chaining. We catch this by the baseFeedParsers, which would not do anything with the gathered data. We pass the event up to the user; if the user doesn't discard it, we add the entry to our 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 decl 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

AtomPersonCollection Authors [get]
 accessor method public Contributors AtomPersonCollection
AtomUri Base [get, set]
 calculates or set's the base uri of an element
string Batch [get, set]
 Retrieves the batch link for the current feed.
GDataBatchFeedData BatchData [get, set]
 accessor to the batchdata for the entry
AtomCategoryCollection Categories [get]
 returns the category collection
AtomPersonCollection Contributors [get]
 accessor method public Contributors AtomPersonCollection
bool Dirty [get, set]
 The dirty property - indicates if exactly this element is dirty.
AtomEntryCollection Entries [get]
 accessor method public ExtensionList Entries
ExtensionList ExtensionElements [get]
 read only accessor for the ExtensionsElements Collections
ExtensionList ExtensionFactories [get]
 read only accessor for the Extension Factories
string Feed [get, set]
 accessor method public string Feed
AtomGenerator Generator [get, set]
 accessor method public FeedGenerator Generator
AtomIcon Icon [get, set]
 accessor method public AtomIcon Icon
AtomId Id [get, set]
 accessor method public string Id
AtomUri ImpliedBase [get, set]
 property that holds the implied base URI
int ItemsPerPage [get, set]
 accessor method public int ItemsPerPage
string Language [get, set]
 returns and sets the xml:lang value
AtomLinkCollection Links [get]
 accessor method public Links AtomLinkCollection
AtomLogo Logo [get, set]
 accessor method public AtomLogo Logo
string NextChunk [get, set]
 accessor method public string NextChunk
string Post [get, set]
 accessor method public string Post
string PrevChunk [get, set]
 accessor method public string PrevChunk
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.
bool ReadOnly [get]
 returns whether or not the entry is read-only
AtomTextConstruct Rights [get, set]
 accessor method public string Rights
string Self [get, set]
 accessor method public string Self
IService Service [get, set]
 accessor method for the gData Service to use
int StartIndex [get, set]
 accessor method public int StartIndex
AtomTextConstruct Subtitle [get, set]
 accessor method public string Subtitle
AtomTextConstruct Title [get, set]
 accessor method public string Title
int TotalResults [get, set]
 accessor method public int TotalResults
DateTime Updated [get, set]
 accessor method public DateTime LastUpdated
override string XmlName [get]
 just returns the constant representing this xml element

Events

FeedParserEventHandler NewAtomEntry
 eventhandler, when the parser creates a new feed entry-> mirrored from underlying parser
ExtensionElementEventHandler NewExtensionElement
 eventhandler, when the parser finds a new extension element-> mirrored from underlying parser

Private Member Functions

 AtomFeed ()
 default constructor
internal override void BaseUriChanged (AtomUri uriBase)
 just go down the child collections

Private Attributes

GDataBatchFeedData batchData
AtomEntryCollection feedEntries
 collection of feed entries
int itemsPerPage
 holds number of items per page
IService service
 holds the service interface to use
int startIndex
 holds the start-index parameter
int totalResults
 holds the total results

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

Generated by  Doxygen 1.6.0   Back to index