Mac Dev Center Mac OS X Reference Library Core Services Layer Publication Subscription Publication Subscription Framework Reference

Overview

A PSEntry is an entry in a feed object. Entry objects are acquired from the associated feed object.

Most of the attributes for an entry are defined by the RSS 2.0 and Atom 1.0 specs. Any attributes defined by those specs (or nonstandard extensions) that are not natively supported by PSEntry can be retrieved from the entry objects' XMLRepresentation property.

Some PSEntry attributes are specific to the local copy of the entry, such as isRead and receivedDate.

Since the values of the RSS and Atom attributes are derived from data received from the server, they may be missing or incorrect. If you have the opportunity, use attributes generated by the Publication Subscription framework, as it is more reliable. For example, using updatedDate to find entries that have been modified since a certain time would be unreliable. Use receivedDate instead. It is not recommended that you subclass PSEntry.

Methods

-extensionXMLElementsUsingNamespace:

Returns an array of the extension XML elements that are outside of the RSS or Atom standards.

Returns an array of the extension XML elements that are outside of the RSS or Atom standards.

- (NSArray *) extensionXMLElementsUsingNamespace:(NSString *)nameSpace; 

Parameters

Return Value

An array containing the extension XML elements requested. Make sure to pass a namespace and not a namespace prefix for the nameSpace parameter. For example, to retrieve the iTunes Podcast elements, use extensionXMLElementsUsingNamespace:@"http://www.itunes.com/dtds/podcast-1.0.dtd", not extensionXMLElementsUsingNamespace:@"itunes". This method attempts to communicate with the PubSubAgent process and causes the agent to launch if it is not already running. If PubSubAgent cannot be contacted, an exception will be thrown with the name PSException. To avoid problems, you should always be prepared to catch an exception thrown by this method.

Availability

Introduced in Mac OS X v10.5.

Properties

alternateURL

The URL to an alternate version of the entry resource. (read-only)

authors

An array of author objects representing the entry's authors. (read-only)

authorsForDisplay

The authors of the entry as a string. (read-only)

baseURL

The base URL for resolving relative links.(read-only)

content

The content of the entry. (read-only)

contributors

An array of author objects that contains the entry's contributors. (read-only)

current

A Boolean value indicating whether an entry still appears in its feed. (read-only)

dateCreated

The date that the entry was created. (read-only)

dateForDisplay

A guaranteed non-nil date for the entry, suitable for displaying or sorting. (read-only)

datePublished

The date that the entry was published. (read-only)

dateUpdated

The date that the entry was last modified. (read-only)

enclosures

An array of enclosure objects of the enclosures of an entry. (read-only)

feed

The feed the receiver belongs to. (read-only)

flagged

A Boolean value indicating whether or not the entry is flagged.

identifier

A string that uniquely identifies an entry. (read-only)

localDateCreated

The date when the entry was created in the local Publication Subscription database. (read-only)

localDateUpdated

The date when the entry was updated in the local Publication Subscription database. (read-only)

read

A Boolean value indicating whether or not the entry is read.

rights

The entry's copyright information. (read-only)

summary

A string that contains the entry's summary. (read-only)

title

The entry's title. (read-only)

titleForDisplay

A string to display as the entry's title. (read-only)

XMLRepresentation

The raw XML entry. (read-only)

The URL to an alternate version of the entry resource. (read-only)

@property (
    readonly,
    retain) NSURL * alternateURL; 

Discussion

Traditionally, the alternate URL corresponds to the HTML version of an entry. The URL is parsed from the element in Atom and the element in RSS. This URL is often called a permalink.

Availability

Introduced in Mac OS X v10.5.

An array of author objects representing the entry's authors. (read-only)

@property (
    readonly,
    retain) NSArray * authors; 

Discussion

The authors correspond to the element in Atom and RSS. This method currently only supports a single author, the first one.

Availability

Introduced in Mac OS X v10.5.

The authors of the entry as a string. (read-only)

@property (
    readonly) NSString* authorsForDisplay; 

Discussion

If there are multiple authors, they are comma-delimited.

Availability

Introduced in Mac OS X v10.5.

The base URL for resolving relative links.(read-only)

@property (
    readonly,
    retain) NSURL * baseURL; 

Discussion

The returned URL corresponds to the xml:base attribute on an Atom element or an RSS element. Publication Subscription resolves all parsed URLs to be absolute. However, this is not possible for URLs embedded within an entry's content or summary. If a client chooses to display content in HTML form, the base URL must be set for relative URLs to work.Note: Atom technically allows the xml:base attribute to appear as an attribute of the or

@property (
    readonly,
    retain) PSContent * content; 

@property (
    readonly,
    retain) NSArray * contributors; 

@property (
    readonly,
    getter=isCurrent) BOOL current; 

@property (
    readonly,
    retain) NSDate * dateCreated; 

@property (
    readonly,
    retain) NSDate * dateForDisplay; 

@property (
    readonly,
    retain) NSDate * datePublished; 

@property (
    readonly,
    retain) NSDate * dateUpdated; 

@property (
    readonly,
    retain) NSArray * enclosures; 

@property (
    readonly) PSFeed * feed; 

@property (
    getter=isFlagged,
    setter=setFlagged:) BOOL flagged; 

@property (
    readonly,
    retain) NSString * identifier; 

@property (
    readonly,
    retain) NSDate * localDateCreated; 

@property (
    readonly,
    retain) NSDate * localDateUpdated; 

@property (
    getter=isRead,
    setter=setRead:) BOOL read; 

@property (
    readonly,
    retain) NSString * rights; 

@property (
    readonly,
    retain) PSContent * summary; 

@property (
    readonly,
    retain) NSString * title;