Mac Developer Library

Developer

PSFeedSettings Class Reference

Options
Deployment Target:

On This Page

PSFeedSettings

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.

Inheritance


Conforms To


Import Statement


Not Applicable

Objective-C

@import PubSub;

Availability


Available in OS X v10.5 and later.
Deprecated in OS X v10.9.
  • Returns a settings object initialized with the default values for a client.

    Declaration

    Objective-C

    + (PSFeedSettings *)defaultClientSettings

    Discussion

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

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.

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

    Declaration

    Objective-C

    + (PSFeedSettings *)defaultFeedSettings

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.

  • refreshInterval refreshInterval (OS X v10.9) Property

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

    Declaration

    Objective-C

    @property NSTimeInterval refreshInterval

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.

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

    Declaration

    Objective-C

    @property BOOL refreshesInBackground

    Discussion

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

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.

  • maxEnclosureSize maxEnclosureSize (OS X v10.9) Property

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

    Declaration

    Objective-C

    @property double maxEnclosureSize

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.

  • expirationInterval expirationInterval (OS X v10.9) Property

    The amount of time before an entry is deleted.

    Declaration

    Objective-C

    @property NSTimeInterval expirationInterval

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.

  • enclosureTypes enclosureTypes (OS X v10.9) Property

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

    Declaration

    Objective-C

    @property(retain) NSArray *enclosureTypes

    Discussion

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

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.

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

    Declaration

    Objective-C

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

    Import Statement

    Objective-C

    @import PubSub;

    Availability

    Available in OS X v10.5 and later.

    Deprecated in OS X v10.9.