Saturday, June 24, 2006

Common Feed List

The Common Feed List resembles a hierarchical file system with folders and feeds.

The IFeedFolder interface contains properties and methods for accessing feeds contained within the folder as well as properties and methods for accessing subfolders.

Because feed folders are mapped to disk directories, folder names are limited to those characters that the file system allows. (See Valid Feed and Folder Names for more information.)

The root folder of the Common Feed List is accessed through the FeedsManager.RootFolder property, which returns an object of type IFeedFolder.

Below are methods and properties that are used to traverse and manipulate the Common Feed List hierarchy.


FeedsManager.RootFolder :IFeedFolder , Returns the top-level system feed folder.
FeedFolder.IsRoot : Boolean, Returns true if top-level folder.
FeedFolder.Subfolders : IFeedsEnum, Returns collection of subfolders.
FeedsManager.GetFolder(path) :IFeedFolder, Returns specific folder by path.
FeedFolder.GetSubfolder(name) : IFeedFolder, Returns specific subfolder.
FeedFolder.Name : String, Returns the name of the folder.
FeedFolder.Parent : IFeedFolder, Returns the parent folder.
FeedFolder.Path :String, Returns the feed list path of the folder.
FeedFolder.TotalItemCount: Integer, Returns an aggregated total of items in all feeds.
FeedFolder.TotalUnreadItemCount:Integer,Returns an aggregated total of unread items in all feeds.
FeedsManager.ExistsFolder(path):Boolean,Returns true if folder exists.
FeedFolder.ExistsSubfolder(name):Boolean,Returns true if subfolder exists.
Create, Delete, Move, Rename Folders
FeedFolder.CreateSubfolder(name) :IFeedFolder,Creates and returns new subfolder.
FeedsManager.DeleteFolder(path):Deletes folder, including its subfolders and feeds.
FeedFolder.Delete:Deletes folder, including its subfolders and feeds.
FeedFolder.Move(path):Moves the folder.
FeedFolder.Rename(name):Renames the folder.
Working with Feeds
The IFeed interface exposes the required and optional elements of an RSS feed.

To subscribe to a feed, merely assign it to a folder.

Below are methods and properties that are used to manage the feeds.
Feeds
FeedsManager.GetFeed(path):IFeed,Returns specific feed, by feed list path.
FeedFolder.GetFeedByUrl(url):IFeed,Returns specific feed, if subscribed, by URL.
FeedFolder.GetFeed(name):IFeed,Returns specific feed by name.
FeedFolder.Feeds:IFeedsEnum,Returns collection of feeds.
Feed.Name:String,Returns the name of the feed.
Feed.Parent:IFeedFolder,Returns the parent folder of the feed.
Feed.Path:String,Returns the feed list path of the feed.
Feed Existence
FeedsManager.ExistsFeed(path):Boolean,Returns true if feed exists.
FeedFolder.ExistsFeed(name):Boolean,Returns true if feed exists.
FeedsManager.IsSubscribed(url):Boolean,Returns true if a feed subscription exists.
Create, Delete, Move, Rename Feeds
FeedFolder.CreateFeed(name,url):IFeed,Creates feed in folder and subscribes to it.
FeedsManager.DeleteFeed(path):Deletes the feed.
Feed.Delete:Deletes the feed.
Feed.Move(path):Moves the feed.
Feed.Rename(name):Renames the feed.

and that's the feed list story

No comments: