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

Overview

A PSFeedSettings object contains settings pertaining to retrieving subscribed feeds. You can access and modify all feed settings, which include refresh and expiration intervals, and enclosure download policies. Initially all the values are set to default settings, meaning that they inherit from the PSClient's own feed settings object, but you can override those by putting explicit values in the feed's feed settings object.

Globally, there can be multiple feed subscriptions with different settings for the same URL. For example, two clients may subscribe to the same feed URL but with different refresh intervals or enclosure policies. In this case the PubSub Agent uses the most liberal policy: the minimum refresh interval, the maximum enclosure size limit, and so on. It is not recommended that you subclass PSFeedSettings.

Methods

+defaultClientSettings

Returns a settings object initialized with the default values for a client.

+defaultFeedSettings

Returns a settings object initialized with the default values for a feed.

Returns a settings object initialized with the default values for a client.

+ (PSFeedSettings*) defaultClientSettings; 

Discussion

The returned object can be used to determine the actual default values of settings such as the refresh interval.

Availability

Introduced in Mac OS X v10.5.

Returns a settings object initialized with the default values for a feed.

+ (PSFeedSettings*) defaultFeedSettings; 

Availability

Introduced in Mac OS X v10.5.

Properties

downloadsEnclosures

A Boolean value that indicates whether or not the PubSub Agent will automatically download enclosures associated with new entries.

enclosureTypes

An array of string objects that contain the enclosure MIME types to be downloaded automatically.

expirationInterval

The amount of time before an entry is deleted.

maxEnclosureSize

The maximum size, in bytes, of an enclosure to be downloaded automatically.

refreshesInBackground

A Boolean value that determines whether or not the PubSub Agent will refresh the feed when the client application is not running.

refreshInterval

The desired time interval that the PubSub Agent will poll for updates.

A Boolean value that indicates whether or not the PubSub Agent will automatically download enclosures associated with new entries.

@property BOOL downloadsEnclosures; 

Discussion

Returns YES if the PubSub Agent will automatically download enclosures, NO if it will not. By default, enclosures are not automatically downloaded.

Availability

Introduced in Mac OS X v10.5.

An array of string objects that contain the enclosure MIME types to be downloaded automatically.

@property (
    retain) NSArray* enclosureTypes; 

Discussion

A wildcard can be used as a MIME subtype, for example, image/ *.

Availability

Introduced in Mac OS X v10.5.

The amount of time before an entry is deleted.

@property NSTimeInterval expirationInterval; 

Availability

Introduced in Mac OS X v10.5.

The maximum size, in bytes, of an enclosure to be downloaded automatically.

@property double maxEnclosureSize; 

Availability

Introduced in Mac OS X v10.5.

A Boolean value that determines whether or not the PubSub Agent will refresh the feed when the client application is not running.

@property BOOL refreshesInBackground; 

Discussion

Returns YES if the PubSub Agent will refresh the feed in the background, NO if it will not.

Availability

Introduced in Mac OS X v10.5.

The desired time interval that the PubSub Agent will poll for updates.

@property NSTimeInterval refreshInterval; 

Availability

Introduced in Mac OS X v10.5.