RSSKit  0.6.1
Public Member Functions
<RSSArticle> Protocol Reference

#import <RSSArticleProtocol.h>

Inheritance diagram for <RSSArticle>:
<RSSMutableArticle>

List of all members.

Public Member Functions

(NSString *) - headline
(NSString *) - url
(NSString *) - content
(NSArray *) - links
(NSDate *) - date
(NSURL *) - enclosure
(void) - setAutoClear:
(BOOL) - autoClear
(id< RSSFeed >) - feed
(NSDictionary *) - plistDictionary
(BOOL) - store
(void) - willBeReplacedByArticle:

Detailed Description

Classes implementing this protocol can be used as RSSArticles.


Member Function Documentation

- (BOOL) autoClear

Returns the feed's autoclear flag. This flag determines if the feed's articles are removed before fetching new articles.

Returns:
the feed's autoclear flag
- (NSString*) content
Returns:
The full text, an excerpt or a summary from the article
- (NSDate*) date

Returns the date of the publication of the article. If the source feed of this article didn't contain information about this date, the fetching date is usually returned.

Returns:
The date of the publication of the article
- (NSURL*) enclosure

Returns the Enclosure object of this article as URL. If there is no enclosure object, nil is returned.

Returns:
the URL of this article's enclosure object
- (id<RSSFeed>) feed

Returns the source feed of this article.

Warning:
It's not guaranteed that this object actually exists. Be aware of segmentation faults!

If you want to make sure the object exists, you have to follow these rules:

  • Don't retain any article!
  • Don't call the (undocumented) setFeed: (Colon!) method.
Returns:
The source feed of this article
- (NSString*) headline
Returns:
The headline of the article
- (NSArray*) links

Returns an NSArray containing NSURL objects or nil, if there are none. The contained NSURL objects often have the "type" and "rel" properties set. See the documentation for addLink: for details.

Returns:
The links of the article.
- (NSDictionary*) plistDictionary

Returns a NSDictionary that represents the article and that can be used to generate the article again. The dictionary must be property list compatible.

- (void) setAutoClear: (BOOL)  autoClear

Sets the feed's autoclear flag. This flag determines if the feed's articles are removed before fetching new articles.

- (BOOL) store

Saves the article to the URL that's calculated by the RSSFactory.

- (NSString*) url
Returns:
The URL of the full version of the article (as NSString*)
- (void) willBeReplacedByArticle: (id)  newArticle

This method is intended to make sure that the replacing article keeps some fields from the old (this) article. Subclasses will probably want to override this, but shouldn't forget calling the super implementation, first.


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