RSSKit  0.6.1
Instance Methods | Class Methods | Protected Attributes | List of all members
RSSFeed Class Reference

#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

Class articleClass
 

Detailed Description

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:

See also
- initWithURL: (RSSFeed)
- fetch (RSSFeed(Fetching))
setAutoClear:
RSSArticle
NSURL

Method Documentation

◆ articleClass()

- (Class) articleClass

Returns the class of the article objects. This will be a subtype of RSSArticle.

Returns
the article class

Referenced by initWithURL:, and setArticleClass:.

◆ articleEnumerator()

- (NSEnumerator *) articleEnumerator
Returns
an enumerator for the articles in this feed

◆ clearArticles()

- (void) clearArticles

Clears the list of articles.

Clears the article list. NOT SYNCHRONIZED!

References lastRetrieval.

◆ description()

- (NSString *) description
Returns
Description of the Feed (the feed name)

References status.

◆ feedFromPlistDictionary:()

+ (id) feedFromPlistDictionary: (NSDictionary*)  plistDictionary

Creates a feed from a suitable Plist-able dictionary representation.

Provided by category RSSFeed(Storage).

References articleClass.

◆ feedName()

- (NSString*) feedName
Returns
The name of the feed

Referenced by initWithURL:, and setFeedName:.

◆ feedURL()

- (NSURL*) feedURL
Returns
the URL where the feed can be downloaded from (as NSURL object)
See also
NSURL

Referenced by initWithURL:, and setFeedName:.

◆ fetch()

- (enum RSSFeedError) fetch

Fetches the feed from the web.

Returns
An error number (of type enum RSSFeedError)
See also
NSURL
RSSFeedError

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).

Provided by category RSSFeed(Fetching).

◆ fetchInBackground()

- (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

Provided by category RSSFeed(Fetching).

◆ initWithURL:()

- (id) initWithURL: (NSURL*)  aURL

Designated initializer.

Parameters
aURLThe URL where the feed can be downloaded from.

Designated initializer

References articleClass, feedName, feedURL, RSSFeed(Fetching)::lastError, lastRetrieval, and status.

◆ isFetching()

- (BOOL) isFetching

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

References status.

◆ lastRetrieval()

- (NSDate*) lastRetrieval

Returns the date of last retrieval of this feed. If the feed hasn't been retrieved yet, this method returns nil.

Returns
The date of last retrieval as a NSDate pointer.

Referenced by clearArticles, initWithURL:, and setArticleClass:.

◆ newArticleFound:()

- (void) newArticleFound: (id)  anArticle

RSSFeed also implements the NewRSSArticleListener informal protocol.

Implementation of the NewRSSArticleListener protocol.

◆ plistDictionary()

- (NSMutableDictionary *) plistDictionary

Returns a Plist-able dictionary representation of this feed.

Provided by category RSSFeed(Storage).

References articleClass.

◆ removeArticle:()

- (void) removeArticle: (RSSArticle*)  article

Deletes an article from the feed.

Parameters
articleThe index of the article to delete.

◆ setArticleClass:()

- (void) setArticleClass: (Class)  aClass

Sets the class of the article objects. This needs to be a subtype of RSSArticle.

Parameters
aClassThe class newly created article objects should have.

References articleClass, and lastRetrieval.

◆ setFeedName:()

- (void) setFeedName: (NSString*)  aFeedName

Sets the feed name

References feedName, and feedURL.

◆ status()

- (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...

Deprecated:
in favor of -isFetching
See also
- isFetching
Returns
either RSSFeedIsFetching or RSSFeedIsIdle

Referenced by description, initWithURL:, and isFetching.

Member Data Documentation

◆ articleClass

- (Class) articleClass
protected

Returns the class of the article objects. This needs to be a subclass of RSSArticle. (Also needed to implement the NewRSSArticleListener class)

Returns
the article class

Referenced by feedFromPlistDictionary:, and plistDictionary.


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