注 : このドキュメントは暫定版であるため、変更される場合があります。
このトピックでは、Microsoft Windows RSS Platform を紹介します。Microsoft Windows RSS Platform は、ユーザーが購読する RSS (Really Simple Syndication) フィードのセット (Common Feed List ※ 1) を操作するために開発者が使用できる API です。このトピックでは、プロパティおよびメソッドを機能カテゴリごとにグループ化して、プラットフォームの技術的な概要およびその特徴について説明します。
※1 現在、ユーザーが購読しているすべての RSS フィードのオープン データベース。RSS データは、アプリケーション間で共有できます。
Windows RSS Platform は、Component Object Model (COM) インターフェイスの 2 つのスタイルをサポートします。
-
事前バインディング (vtable) インターフェイス :
C/C++ 開発者に適したインターフェイス。これらのオブジェクトは、IXFeedsManager (英語) 階層構造に含まれます。
-
遅延バインディング (IDispatch) インターフェイス :
スクリプト記述およびマネージ コード (Microsoft Visual Basic .NET および C#) に適した COM オートメーション インターフェイス。これらは、IFeedsManager (英語) オブジェクトです。
不要な繰り返しを避けるため、この記事では COM オートメーション インターフェイスの名前を使用します。
このトピックには、以下の内容が含まれています。
目次
.gif)
はじめに
Common Feed List
フィードを操作する
RSS 2.0 の要素
関連項目
はじめに
Windows Internet Explorer 7 の RSS サポートの一部として、ユーザーは、ブラウザ内で RSS フィードを検出して購読できます。ユーザーがフィードを購読すると、そのフィードが Common Feed List に追加されます。Common Feed List は、クライアントの独自のリストの補完または代替として使用できます。たとえば、Microsoft Office Outlook 2007 では、ユーザーのサブスクリプション リストに Common Feed List のフィードをインポートできます。この機能により、Internet Explorer 内でのフィードの検出が可能になり、検出されたフィードをその他のアプリケーションで表示することができます。
Feed Download Engine ※ 2 は、フィードをダウンロードして、新しい項目をフィード ストアの既存のデータに結合します。Windows RSS Platform を使用することにより、アプリケーションはフィード データをユーザーに公開することができます。たとえば、Windows Vista の RSS Explorer では、ニュースおよびブログ フィードの高度なテキスト表示が可能で、Microsoft Windows Media Player では、オーディオ フィードを再生することができます。フィード データの使用はアプリケーションごとに異なります。Windows RSS Platform では、フィード データへの簡単なアクセスが提供されるので、さまざまなシナリオが可能になります。
※2 新しい RSS フィードをフィード ストアに結合するバックグラウンド プロセス。
Windows RSS Platform の最上位オブジェクトは、FeedsManager (英語) オブジェクトです。スクリプト記述用のオブジェクトを作成するには、ProgIDMicrosoft.FeedsManager を使用します。C/C++ で使用するオブジェクトを作成するには、CoCreateInstance (英語) と CLSID_FeedsManager を呼び出します (CLSID_FeedsManager は msfeeds.h ヘッダー ファイルで定義されています) 。
Windows RSS Platform オブジェクト モデルの階層構造を次に示します。
.gif)
Common Feed List
Common Feed List は、フォルダおよびフィードを含み、階層構造のファイル システムに似ています。IFeedFolder (英語) インターフェイスには、フォルダ内に含まれるフィードにアクセスするためのプロパティとメソッドだけでなく、サブフォルダにアクセスするためのプロパティとメソッドも含まれています。フィード フォルダはディスク ディレクトリにマップされているので、フォルダ名に使用できる文字は、ファイル システムで許可されている文字に制限されます (詳細については、「Valid Feed and Folder Names (英語) 」を参照してください)。
Common Feed List のルート フォルダは、FeedsManager.RootFolder (英語) プロパティを介してアクセスされます。このプロパティは、IFeedFolder 型のオブジェクトを返します。各 IFeedFolder オブジェクトは、サブフォルダおよびフィードの独自のコレクションを含みます (フィードの総数を返す再帰的なフォルダ検索のデモについては、「Subfolders (英語) 」の例を参照してください)。
次の表に、Common Feed List の階層構造を移動および操作するために使用されるメソッドおよびプロパティの一覧を示します。
フォルダフォルダの有無フォルダの作成、削除、移動、名前の変更 フィードを操作する
IFeed (英語) インターフェイスは、RSS フィードの必須およびオプションの要素を公開します。フィードを購読するには、目的のフィードをフォルダに割り当てます。次の表に、フィードを管理するために使用されるメソッドおよびプロパティの一覧を示します。
フィードフィードの有無 | FeedsManager.ExistsFeed(path) (英語) | ブール型 | フィードが存在する場合、true を返します。 |
| FeedFolder.ExistsFeed(name) (英語) | ブール型 | フィードが存在する場合、true を返します。 |
| FeedsManager.IsSubscribed(url) (英語) | ブール型 | フィード サブスクリプションが存在する場合、true を返します。 |
フィードの作成、削除、移動、名前の変更 | FeedFolder.CreateFeed(name,url) (英語) | IFeed | フォルダ内にフィードを作成して購読します。 |
| FeedsManager.DeleteFeed(path) (英語) | | フィードを削除します。 |
| Feed.Delete (英語) | | フィードを削除します。 |
| Feed.Move(path) (英語) | | フィードを移動します。 |
| Feed.Rename(name) (英語) | | フィードの名前を変更します。 |
RSS 2.0 の要素
RSS 2.0 フィードのほとんどの XML 要素は、関連付けられたオブジェクト上の読み取り専用プロパティとして使用可能です。一部のチャネル要素 (cloud、rating、skipDays、skipHours など) は IFeed インターフェイス上でプロパティとして使用できませんが、これらはフィードの XML ソースです。Windows RSS Platform でリストを管理するために使用されるプロパティは、追加の名前空間拡張子によって定義されます (「Simple List Extensions (英語) 」を参照してください)。
IFeed
IFeed (英語) インターフェイスは、RSS チャネル要素上に存在するプロパティを公開します。
フィード要素 | Feed.Copyright (英語) | 文字列 | オプション。チャネルの著作権情報を返します。 |
| Feed.Description (英語) | 文字列 | 必須。チャネルの説明を返します。 |
| Feed.Image (英語) | 文字列 | オプション。フィード ロゴの URL を返します。 |
| Feed.Language (英語) | 文字列 | オプション。フィードの言語コードを返します。 |
| Feed.LastBuildDate (英語) | 浮動小数点数 | オプション。コンテンツの最終更新日を返します。 |
| Feed.Link (英語) | 文字列 | 必須。フィードのホームページの URL を返します。 |
| Feed.PubDate (英語) | 浮動小数点数 | オプション。フィード コンテンツの発行日を返します。 |
| Feed.Title (英語) | 文字列 | 必須。フィードのタイトルを返します。 |
| Feed.Ttl (英語) | 文字列 | オプション。フィードの有効期間 (TTL) を返します。 |
XML ソース | Feed.Xml(count,sort,filter,include) (英語) | 文字列 | フィードの新規 XML ドキュメントを返します。 |
Common Feed List のプロパティ | Feed.DownloadUrl (英語) | 文字列 | セキュリティ ゾーンのマッピングに使用される URL を返します。 |
| Feed.IsList (英語) | ブール型 | フィードをリストとして扱うかどうかを返します。 |
| Feed.ItemCount (英語) | 整数 | 項目の数を返します。 |
| Feed.Items (英語) | IFeedsEnum | 項目のコレクションを返します。 |
| Feed.LastWriteTime (英語) | 文字列 | 作成日時または最終更新日時を返します。 |
| Feed.LocalEnclosurePath (英語) | 文字列 | ダウンロードされたエンクロージャ (ファイル) が保存されるシステム フォルダを返します。 |
| Feed.LocalId (英語) | 文字列 | フィードに割り当てられた GUID を返します。 |
| Feed.MarkAllItemsRead (英語) | 文字列 | すべての項目の既読ステータスを true に設定します。 |
| Feed.Name (英語) | 文字列 | フィードの名前を返します。 |
| Feed.Parent | IFeedFolder | フィードの親フォルダを返します。 |
| Feed.Path (英語) | 文字列 | フィードのフィード リスト パスを返します。 |
| Feed.UnreadItemCount (英語) | 未読項目の数を返します。 | |
| Feed.Url (英語) | 文字列 | Returns the source URL of the feed |
IFeedItem
フィードの個々の項目は、FeedItem (英語) オブジェクトで表されます。これらの項目は、フィードの種類に応じて、フィードに結合されるニュース項目として、または以前のリストのコンテンツを置き換えるリスト項目として集計されます。GUID やソースなどの追加の RSS 2.0 項目要素は、フィードの XML ソース ドキュメント内で使用可能です。
項目要素 | FeedItem.Author (英語) | 文字列 | オプション。作成者の電子メール アドレスを返します。 |
| FeedItem.Comments (英語) | 文字列 | オプション。関連コメントのページの URL を返します。 |
| FeedItem.Description (英語) | 文字列 | 必須。項目の概要を返します。 |
| FeedItem.Guid (英語) | 文字列 | オプション。項目の GUID を返します。 |
| FeedItem.Link (英語) | 文字列 | 必須。項目のソース URL を返します。 |
| FeedItem.Modified (英語) | 浮動小数点数 | オプション。最終更新日時を返します。 |
| FeedItem.PubDate (英語) | 浮動小数点数 | オプション。項目が公開されたときを示します。 |
| FeedItem.Title (英語) | 文字列 | 必須。項目のタイトルを返します。 |
XML Source | FeedItem.Xml(include) (英語) | 文字列 | 項目の XML フラグメントを返します。 |
Common Feed List Properties | FeedItem.DownloadUrl (英語) | 文字列 | セキュリティ ゾーン マッピングに使用される URL を返します。 |
| FeedItem.Enclosure (英語) | IFeedEnclosure (英語) | 項目に関連付けられたエンクロージャ (メディア オブジェクト) を返します。 |
| FeedItem.IsRead (英語) | ブール型 | 項目が表示済みの場合、true を返します。 |
| FeedItem.LocalId (英語) | 整数 | Feed Download Engine によって割り当てられた ID を返します。 |
| FeedItem.Parent (英語) | IFeed | 親フィードを返します。 |
IFeedEnclosure
IFeedEnclosure (英語) インターフェイスは、各フィード項目に関連付けることのできるオプションのメディア添付ファイルへのアクセスを提供します。
エンクロージャ属性 | FeedEnclosure.Length (英語) | 整数 | 必須。エンクロージャの長さ (バイト) を返します。 |
| FeedEnclosure.Type (英語) | 文字列 | 必須。MIME タイプを返します。 |
| FeedEnclosure.Url (英語) | 文字列 | 必須。ファイルのソース URL を返します。 |
Common Feed List のプロパティ | FeedEnclosure.DownloadMimeType (英語) | 文字列 | 最終的な MIME タイプを返します。 |
| FeedEnclosure.DownloadUrl (英語) | 文字列 | セキュリティ ゾーン マッピングに使用される URL を返します。 |
| FeedEnclosure.LocalPath (英語) | 文字列 | ダウンロードしたファイルのローカル システム パスを返します。 |
| FeedEnclosure.Parent (英語) | IFeedItem (英語) | 親フィード項目を返します。 |
フィードの同期
Internet Explorer 7 アグリゲータ (Feed Download Engine) は、フィードで指定されているソース URL からフィード項目を自動的にダウンロードします。これらのダウンロードは、スケジュールに基づいて実行するか、ユーザーの要求に応じて実行することができます。フィードをダウンロードする間隔は、Interval (英語) プロパティの値およびフィードの Ttl 要素によって決定されます。フィードの更新は、現在の時間が LastDownloadTime (英語) とこれらの 2 つの値の最大値を加えたものに等しい場合に実行されます。
次の表に、フィードのダウンロードおよび同期の動作を制御するメソッドおよびプロパティを示します。
バックグラウンド同期 | FeedsManager.AsyncSyncAll (英語) | | LastDownloadTime および Ttl に関係なく、すべてのフィードを更新します。 |
| FeedsManager.BackgroundSync(action) (英語) | | 選択できるアクションは、Enable (有効)、Disable (無効)、または RunNow (今すぐ実行) です。 |
| FeedsManager.BackgroundSyncStatus (英語) | FEEDS_BACKGROUNDSYNC_STATUS (英語) | Feed Download Engine のステータス (Disabled、Enabled) を返します。 |
| FeedsManager.DefaultInterval (英語) | 数値 | システムで定義されたダウンロード間隔 (分) を返します。 |
| FeedsManager.ItemCountLimit (英語) | 数値 | 項目を保持する期限を返します。 |
| Feed.DownloadEnclosuresAutomatically (英語) | ブール型 | フィードと一緒にエンクロージャが自動的にダウンロードされる場合、true を返します。 |
| Feed.Interval (英語) | 数値 | Feed Download Engine がフィードをダウンロードする間隔 (分) を返します。 |
| Feed.MaxItemCount (英語) | 数値 | フィードをダウンロードする際に維持する項目数を返します。 |
| Feed.SyncSetting (英語) | FEEDS_SYNC_SETTING (英語) | ローカルの間隔設定を使用するかグローバルの間隔設定を使用するかを指定します。または、自動ダウンロードを無効にします。 |
| Feed.Ttl (英語) | 文字列 | 文字列 フィードの XML に基づいてフィードをキャッシュする期間 (分) を返します。 |
Download (On Demand) | Feed.Download (英語) | | フィードをダウンロードして、そのコンテンツをシステムのフィード リストに結合します。 |
| FeedEnclosure.AsyncDownload (英語) | | エンクロージャをダウンロードします。 |
| FeedEnclosure.CancelAsyncDownload (英語) | | 実行中のダウンロード操作をキャンセルします。 |
Success Indicators | Feed.LastDownloadTime (英語) | 浮動小数点数 | 正常に行われた最後のダウンロードの日時を返します。 |
| FeedItem.LastDownloadTime (英語) | 浮動小数点数 | 正常に行われた最終更新の日時を返します。 |
| Feed.LastDownloadError (英語) | FEEDS_DOWNLOAD_ERROR (英語) | フィードのダウンロード エラーを返します (存在する場合)。 |
| Feed.DownloadStatus (英語) | FEEDS_DOWNLOAD_STATUS (英語) | フィードのステータスを返します。 |
| FeedEnclosure.LastDownloadError | FEEDS_DOWNLOAD_ERROR | エンクロージャのダウンロード エラーを返します (存在する場合)。 |
| FeedEnclosure.DownloadStatus | FEEDS_DOWNLOAD_STATUS | エンクロージャのステータスを返します。 |
関連項目
-
Events in the Windows RSS Platform (英語)
-
Simple List Extensions (英語)
-
Understanding the Feed Download Engine (英語)