Summary: Methods | Inherited Methods | [Expand All]

public interface

IFeed

implements IAtom

com.google.gdata.data.IFeed

Known Indirect Subclasses

AbPageVariationFeed, AccountFeed, AclFeed, ActivityFeed, AlbumFeed, ArchiveFeed, AttendeeFeed, BaseEventFeed<F extends BaseEventFeed<F, E extends BaseEventEntry<E>>, E>, BaseFeed<F extends BaseFeed, E extends BaseEntry>, BaseHealthFeed<F extends BaseHealthFeed, E extends BaseHealthEntry>, BlogCommentFeed, BlogFeed, BlogPostFeed, CalendarEventFeed, CalendarFeed, and 74 others.

AbPageVariationFeed	Feed element in AbPageVariationFeed.
AccountFeed	Feed element in account feed.
AclFeed	Defines a feed of an access control list (ACL).
ActivityFeed	Describes an activity feed.
AlbumFeed	Feed for an Album in our google photos api.
ArchiveFeed	Describes an Archive feed.
AttendeeFeed	For attendee feeds
BaseEventFeed<F extends BaseEventFeed<F, E extends BaseEventEntry<E>>, E>	Customizes the base feed class to define a feed of events.
BaseFeed<F extends BaseFeed, E extends BaseEntry>	The BaseFeed class is an abstract base class that represents a generic GData feed object, based primarily on the data model for an `<atom:feed>` element.
BaseHealthFeed<F extends BaseHealthFeed, E extends BaseHealthEntry>	Describes a health feed.
BlogCommentFeed	Describes a feed of an entire blog's comments.
BlogFeed	Describes a feed of a user's blogs.
BlogPostFeed	Describes a feed of a blog's posts.
CalendarEventFeed	Describes a Calendar event feed.
CalendarFeed	Describes a feed of Calendars.
CaptionTrackFeed	A feed of `CaptionTrackEntry`
CellFeed	The feed for spreadsheet cells of Google Spreadsheets.
ChangelogFeed	Describes a feed for retrieving a list of changed documents.
ChannelFeed	Feed containing channels.
CodeSearchFeed	The CodeSearchFeed class customizes the generic BaseFeed class to define a feed to search for code.
CollectionFeed	Describes a Book Search collection feed.
CombinationFeed	Feed element in CombinationFeed.
CommentFeed	Object representation for the comment feed.
ComplaintFeed	A feed that contains a list of `ComplaintEntry`.
ContactFeed	This class is deprecated. Please use `ContactFeed` instead.
ContactGroupFeed	Describes a contact group feed.
ContentFeed	Describes a content feed.
CrawlIssuesFeed	Feed of crawl issues for a particular site.
DataFeed	Feed element in data feed.
DocumentExportFeed	Describes a feed for a list of export requests.
DocumentFeed	Describes a document feed.
DocumentListFeed	A feed for managing lists of documents from the Google Docs & Spreadsheets.
EmailListFeed
EmailListRecipientFeed
EventFeed	Describes an event feed.
ExperimentFeed	Feed element in ExperimentFeed.
FavoriteFeed	A YouTube favorite feed.
FeatureFeed	Describes a feature feed.
Feed	The Feed class is a base class that represents a generic GData feed object, based primarily on the data model for an `<atom:feed>` element.
FriendFeed	A feed that contains a list of `FriendEntry`.
GenericFeed	GData feed class that models a generic feed which simply contains a list of generic entries, each have nothing more than a set of key-value pairs.
GlossaryFeed	Describes a glossary feed.
GoogleBaseFeed	An ATOM feed containing entries of type `GoogleBaseEntry`.
GoogleBaseMediaFeed	Media feed used for managing the media attachments for one Google Base Item.
GphotoFeed<F extends GphotoFeed>	This class customizes the generic MediaFeed class to define a feed of GphotoEntries.
IssueCommentsFeed	Describes an issue comments feed.
IssuesFeed	Google Code Project Issues Feed.
KeywordsFeed	Feed of keywords for a particular site.
ListFeed	The feed for treating a spreadsheet as a collection of list items.
MailItemFeed	The MailItemFeed class customizes the generic BaseEntry class to define a feed of MailItem entries.
ManagementFeed	Feed element in data source feed.
MapFeed	Describes a map feed.
MediaFeed<F extends BaseFeed, E extends BaseEntry>	The MediaFeed class extends `BaseFeed` to add media-related operations for feeds that contain media content.
MessageFeed	Describes a message feed.
MessagesFeed	The MessagesFeed class extends the BaseFeed class to define a feed of messages.
MetadataFeed	Describes an Metadata feed.
NicknameFeed
PhotoFeed	Feed for a Photo in our google data api.
PlaylistFeed	A YouTube playlist feed.
PlaylistLinkFeed	A feed that contains playlist link entries.
PortfolioFeed	Describes a Finance portfolio feed.
PositionFeed	Describes a Finance position feed.
PostCommentFeed	Describes a feed of a blog post's comments.
ProfileFeed	Describes a profile feed.
ProjectsFeed	Google Code Projects Feed.
RatingFeed	Object representatino for the rating feed.
RecordFeed	Describes a feed of a table's records.
RegisterFeed	Describes a register feed.
RevisionFeed	A read-only feed from which a particular version of a document can be fetched.
SectionFeed	Feed element in SectionFeed.
SidewikiEntryFeed	Describes a feed of Sidewiki entries.
SidewikiUserFeed	Describes a feed of Sidewiki users.
SiteFeed	Describes a site feed.
SitemapsFeed	The SitemapsFeed class customizes the generic BaseFeed class to define a feed of sitemaps that Webmaster Tools user has for a given site.
SitesFeed	The SitesFeed class customizes the generic BaseFeed class to define a feed of web sites that Webmaster Tools user has.
SpreadsheetFeed	The feed for getting a list of Spreadsheets within a sheet.
SubscriptionFeed	A feed that contains playlist link entries.
TableFeed	Describes a feed of a spreadsheet's tables.
TransactionFeed	Describes a Finance transaction feed.
TranslationMemoryFeed	Describes a translation memory feed.
UserEventFeed	A feed that contains user event entries.
UserFeed	Feed for a User in our google photos api.
UserProfileFeed	Feed containing user profiles.
VariationFeed	Feed element in VariationFeed.
VersionFeed	Describes a version feed.
VideoFeed	Video feed returned by the feed providers.
VideoMessageFeed	Shared video feed (inbox).
VolumeFeed	Describes a Book Search volume feed.
WorksheetFeed	The feed for getting a list of worksheets within a sheet.

Class Overview

Shared interface for model and data BaseFeed to implement.

Summary

Public Methods
abstract IEntry	createEntry() Creates a new entry of the appropriate type for this feed.
abstract boolean	getCanPost() Returns true if this feed accepts entries POSTed to it.
abstract List<? extends IEntry>	getEntries() Returns a list of entries for this feed.
abstract ILink	getEntryPostLink() Returns the entry post link for the feed.
abstract ILink	getFeedBatchLink() Returns the link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed.
abstract IGenerator	getGenerator() Returns the atom:generator element on this feed.
abstract int	getItemsPerPage() Gets the number of items that will be returned per page for paged feeds.
abstract String	getLogo() Returns the value of the atom:logo element.
abstract ILink	getNextLink() Returns the link that provides the URI of next page in a paged feed.
abstract ILink	getPreviousLink() Returns the link that provides the URI of previous page in a paged feed.
abstract int	getStartIndex() Gets the starting index of the contained entries for paged feeds.
abstract ITextConstruct	getSubtitle() Returns the atom:subtitle element of this feed.
abstract int	getTotalResults() Gets the total number of results associated with this feed.
abstract void	setCanPost(boolean canPost) Sets whether this feed accepts entries POSTed to it.
abstract IGenerator	setGenerator(String version, String uri, String name) Sets the atom:generator element on this feed.
abstract void	setItemsPerPage(int numResults) Sets the number of items that will be returned per page for paged feeds.
abstract void	setLogo(String logo) Sets the value of the logo field on this feed.
abstract void	setStartIndex(int startIndex) Sets the starting index of the contained entries for paged feeds.
abstract void	setTotalResults(int totalResults) Sets the total number of results associated with this feed.

[Expand]

Inherited Methods

From interface com.google.gdata.data.IAtom

abstract ILink	addLink(String rel, String type, String href) Adds a link with the given rel, type, and href.
abstract List<? extends IPerson>	getAuthors() Returns the list of all authors on this resource.
abstract Set<? extends ICategory>	getCategories() Returns a set of categories on this resource.
abstract String	getEtag() Gets the value of the gd:etag attribute for this resource.
abstract String	getId() Get the unique id for this resource.
abstract String	getKind() Returns the value of the gd:kind attribute for this resource.
abstract ILink	getLink(String rel, String type) Returns a particular atom:link element with the given rel and type, or null if one was not found.
abstract List<? extends ILink>	getLinks() Returns a list of atom:link elements on this resource.
abstract ILink	getSelfLink() Returns the self link for the resource.
abstract ITextConstruct	getTitle() Returns the atom:title element of this resource.
abstract DateTime	getUpdated() Get a `DateTime` instance representing the last time this resource was updated.
abstract String	getVersionId() Version ID.
abstract void	removeLinks(String relToMatch, String typeToMatch) Remove all links that match the given `rel` and `type` values.
abstract void	removeLinks() Removes all links from the this resource.
abstract void	setEtag(String etag) Sets the value of the gd:etag attribute for this resource.
abstract void	setId(String id) Sets the unique id for this resource.
abstract void	setKind(String kind) Sets the value of the gd:kind attribute for this resource.
abstract void	setService(Service s) Sets the service that this resource is being used with.
abstract void	setUpdated(DateTime updated) Sets the last time this resource was updated.
abstract void	setVersionId(String versionId) Sets the versionId.

Public Methods

public abstract IEntry createEntry ()

Creates a new entry of the appropriate type for this feed.

public abstract boolean getCanPost ()

Returns true if this feed accepts entries POSTed to it.

public abstract List<? extends IEntry> getEntries ()

Returns a list of entries for this feed. The actual type of this list will depend on the data model used for the Feed.

public abstract ILink getEntryPostLink ()

Returns the entry post link for the feed.

public abstract ILink getFeedBatchLink ()

Returns the link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed.

Returns

Link that provides the URI that can be used to batch operations to query, insert, update and delete entries on this feed or null for none.

public abstract IGenerator getGenerator ()

Returns the atom:generator element on this feed.

public abstract int getItemsPerPage ()

Gets the number of items that will be returned per page for paged feeds. A value of UNDEFINED indicates the page item count is undefined.

public abstract String getLogo ()

Returns the value of the atom:logo element.

public abstract ILink getNextLink ()

Returns the link that provides the URI of next page in a paged feed.

Returns

Link that provides the URI of next page in a paged feed or null for none.

public abstract ILink getPreviousLink ()

Returns the link that provides the URI of previous page in a paged feed.

Returns

Link that provides the URI of previous page in a paged feed or null for none.

public abstract int getStartIndex ()

Gets the starting index of the contained entries for paged feeds. A value of UNDEFINED indicates the start index is undefined.

public abstract ITextConstruct getSubtitle ()

Returns the atom:subtitle element of this feed.

public abstract int getTotalResults ()

Gets the total number of results associated with this feed. The value may be larger than the number of contained entries for paged feeds. A value of UNDEFINED indicates the total size is undefined.

public abstract void setCanPost (boolean canPost)

Sets whether this feed accepts entries POSTed to it.

Parameters

canPost

public abstract IGenerator setGenerator (String version, String uri, String name)

Sets the atom:generator element on this feed. This method will create the appropriate type of element or extension based on the data model in use.

Parameters

version
uri
name

public abstract void setItemsPerPage (int numResults)

Sets the number of items that will be returned per page for paged feeds. A value of UNDEFINED indicates the page item count is undefined.

Parameters

numResults

public abstract void setLogo (String logo)

Sets the value of the logo field on this feed.

Parameters

logo

public abstract void setStartIndex (int startIndex)

Sets the starting index of the contained entries for paged feeds. A value of UNDEFINED indicates the start index is undefined.

Parameters

startIndex

public abstract void setTotalResults (int totalResults)

Sets the total number of results associated with this feed. The value may be larger than the number of contained entries for paged feeds. A value of UNDEFINED indicates the total size is undefined.

Parameters

totalResults

Interfaces

Classes

Annotations

Enums

Exceptions

IFeed

Class Overview

Summary

Public Methods

public abstract IEntry createEntry ()

public abstract boolean getCanPost ()

public abstract List<? extends IEntry> getEntries ()

public abstract ILink getEntryPostLink ()

public abstract ILink getFeedBatchLink ()

Returns

public abstract IGenerator getGenerator ()

public abstract int getItemsPerPage ()

public abstract String getLogo ()

public abstract ILink getNextLink ()

Returns

public abstract ILink getPreviousLink ()

Returns

public abstract int getStartIndex ()

public abstract ITextConstruct getSubtitle ()

public abstract int getTotalResults ()

public abstract void setCanPost (boolean canPost)

Parameters

public abstract IGenerator setGenerator (String version, String uri, String name)

Parameters

public abstract void setItemsPerPage (int numResults)

Parameters

public abstract void setLogo (String logo)

Parameters

public abstract void setStartIndex (int startIndex)

Parameters

public abstract void setTotalResults (int totalResults)

Parameters