RSSKit 0.6.1
|
#import <RSSFeed.h>
Inherits NSObject, and <RSSMutableFeed>.
Instance Methods | |
(id) | - initWithURL: |
(NSString *) | - description |
(enum RSSFeedStatus) | - status |
(BOOL) | - isFetching |
(NSEnumerator *) | - articleEnumerator |
(void) | - removeArticle: |
(void) | - setFeedName: |
(NSString *) | - feedName |
(NSURL *) | - feedURL |
(void) | - clearArticles |
(void) | - setArticleClass: |
(Class) | - articleClass |
(NSDate *) | - lastRetrieval |
(void) | - newArticleFound: |
(enum RSSFeedError) | - fetch |
(void) | - fetchInBackground |
(NSMutableDictionary *) | - plistDictionary |
Class Methods | |
(id) | + feedFromPlistDictionary: |
Protected Attributes | |
enum RSSFeedError | lastError |
Class | articleClass |
Objects of this class represent a RSS/ATOM feed, which is basically just a source for new articles. When creating a RSSFeed object, you'll just have to provide it with the URL, where the feed can be downloaded from.
This is the generic way to read feeds:
NSURL* url = [NSURL URLWithString:"http://www.example.com/feed.xml"];
RSSFeed* feed = [RSSFeed initWithURL: url];
[feed fetch]; // alternatively [feed fetchInBackground];
[feed setAutoClear: NO];
NSSet* articles = [feed articleSet];
- (Class) articleClass |
Returns the class of the article objects. This will be a subtype of RSSArticle.
- (NSEnumerator *) articleEnumerator |
Reimplemented from <RSSFeed>.
- (void) clearArticles |
Clears the list of articles.
Clears the article list. NOT SYNCHRONIZED!
- (NSString *) description |
+ (id) feedFromPlistDictionary: | (NSDictionary*) | plistDictionary |
Creates a feed from a suitable Plist-able dictionary representation.
Provided by category RSSFeed(Storage).
- (NSString *) feedName |
Reimplemented from <RSSFeed>.
- (NSURL *) feedURL |
Reimplemented from <RSSFeed>.
- (enum RSSFeedError) fetch |
Fetches the feed from the web.
Fetches the feed from its feed URL, parses it and adds the found articles to the list of articles contained in this feed (if they are new).
Reimplemented from <RSSFeed>.
Provided by category RSSFeed(Fetching).
- (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.
Reimplemented from <RSSFeed>.
Provided by category RSSFeed(Fetching).
- (id) initWithURL: | (NSURL*) | aURL |
Designated initializer.
aURL | The URL where the feed can be downloaded from. |
Designated initializer
- (BOOL) isFetching |
Returns YES if and only if this feed is currently being fetched.
Reimplemented from <RSSFeed>.
- (NSDate *) lastRetrieval |
Returns the date of last retrieval of this feed. If the feed hasn't been retrieved yet, this method returns nil.
- (void) newArticleFound: | (id) | anArticle |
RSSFeed also implements the NewRSSArticleListener informal protocol.
Implementation of the NewRSSArticleListener protocol.
- (NSMutableDictionary *) plistDictionary |
Returns a Plist-able dictionary representation of this feed.
Provided by category RSSFeed(Storage).
- (void) removeArticle: | (RSSArticle*) | article |
Deletes an article from the feed.
article | The index of the article to delete. |
- (void) setArticleClass: | (Class) | aClass |
Sets the class of the article objects. This needs to be a subtype of RSSArticle.
aClass | The class newly created article objects should have. |
- (void) setFeedName: | (NSString*) | aFeedName |
Sets the feed name
- (enum RSSFeedStatus) status |
Accessor for the status of the feed. This can be used by a multithreaded GUI to indicate if a feed is currently fetching...
|
protected |
Returns the class of the article objects. This needs to be a subclass of RSSArticle. (Also needed to implement the NewRSSArticleListener class)
|
protected |
Returns the last fetching error.
Returns the last error. Guaranteed to return the last fetching result.
Provided by category RSSFeed(Fetching).