RSSKit  0.6.1
Public Member Functions
<RSSFeed> Protocol Reference

#import <RSSFeedProtocol.h>

Inherited by <RSSMutableFeed>.

List of all members.

Public Member Functions

(NSEnumerator *) - articleEnumerator
(NSSet *) - articleSet
(int) - articleCount
(BOOL) - isFetching
(NSString *) - feedName
(NSURL *) - feedURL
(enum RSSFeedError) - fetch
(void) - fetchInBackground
(enum RSSFeedError) - lastError
(NSMutableDictionary *) - plistDictionary

Detailed Description

The RSS feed protocol defines the way users are supposed to talk to a feed.


Member Function Documentation

- (int) articleCount
Returns:
the number of articles in this feed
- (NSEnumerator*) articleEnumerator
Returns:
an enumerator for the articles in this feed
- (NSSet*) articleSet
Returns:
a set that contains this feed's articles
- (NSString*) feedName
Returns:
The name of the feed
- (NSURL*) feedURL
Returns:
the URL where the feed can be downloaded from (as NSURL object)
See also:
NSURL
- (enum RSSFeedError) fetch

Fetches the feed from the web.

Returns:
An error number (of type enum RSSFeedError)
See also:
NSURL
RSSFeedError
- (void) fetchInBackground

Fetches the feed from the web. Feed fetching is done in the background. When the feed is fetched, the feed will post a RSSFeedFetchedNotification.

See also:
RSSFeedFetchedNotification
- (BOOL) isFetching

Returns YES if and only if this feed is currently being fetched.

- (enum RSSFeedError) lastError

Returns the last fetching error.

- (NSMutableDictionary*) plistDictionary

Returns a NSDictionary object that is property-list compatible and contains all information required to rebuild this article object.


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