摘要提供者套件資訊清單 XML 格式
注意
針對發行前產品的部分相關資訊,在產品正式發行時可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
為了在 Widgets Board 上顯示,支援 Windows 摘要的應用程式必須向系統註冊其摘要提供者。 若為 Win32 應用程式,目前僅支援已封裝的應用程式,摘要提供者會在應用程式套件資訊清單檔案中指定其註冊資訊。 本文章記載摘要註冊的 XML 格式。 如需 Win32 摘要提供者範例套件資訊清單的程式碼清單,請參閱範例一節。
應用程式延伸模組
應用程式套件資訊清單檔案支援 Windows 應用程式的許多不同延伸模組與功能。 應用程式套件資訊清單格式是由一組架構所定義,記載於套件資訊清單的結構描述參考。 摘要提供者會在 uap3:AppExtension 中宣告其註冊資訊。 延伸模組的 Name 屬性必須設定為「com.microsoft.windows.widgets.feeds」。
摘要提供者應該包含 uap3:Properties 做為 uap3:AppExtension 的子系。 套件資訊清單架構不會強制執行 uap3:Properties 元素的結構,只會要求格式正確的 XML。 本文的其餘部分說明 Widgets Board 預期的 XML 格式,目的是要成功註冊摘要提供者。
<uap3:Extension Category="windows.appExtension">
<uap3:AppExtension Name="com.microsoft.windows.widgets.feeds" DisplayName="ContosoApp" Id="ContosoApp" PublicFolder="Public">
<uap3:Properties>
<!-- Feed provider registration content goes here -->
</uap3:Properties>
</uap3:AppExtension>
</uap3:Extension>
元素階層
FeedProvider
啟用
CreateInstance
定義
定義
FeedProvider
摘要提供者註冊資訊的根元素。
屬性 | 類型 | 必要 | 描述 | 預設值 |
---|---|---|---|---|
說明 | string | Yes | 摘要提供者的簡短說明。 | N/A |
DisplayName | 字串 | Yes | Widgets Board 上顯示的摘要提供者名稱。 | N/A |
圖示 | 字串 | Yes | Widgets Board 中顯示的圖示影像檔套件相對路徑。 | N/A |
Id | string | Yes | 辨識摘要提供者的識別碼。 摘要提供者實作會使用此字串來判斷或指定每個作業所參考的應用程式摘要提供者。 對於應用程式資訊清單檔案內定義的所有摘要提供者,此字串必須是唯一的。 | N/A |
啟用
指定摘要提供者的啟用資訊。
CreateInstance
CreateInstance 應指定給實作 IFeedProvider 介面的 Win32 摘要提供者。 系統會透過呼叫 CoCreateInstance 來啟動介面。 ClassId 屬性會指定 CLSID 用於實作 IFeedProvider 介面的 CreateInstance 伺服器。
屬性 | 類型 | 必要 | 描述 | 預設值 |
---|---|---|---|---|
ClassId | GUID | Yes | 實作摘要提供者之 CreateInstance 伺服器的 CLSID。 | N/A |
定義
一個或多個摘要註冊的容器元素。
定義
表示單一摘要的註冊。
屬性 | 類型 | 必要 | 描述 | 預設值 |
---|---|---|---|---|
Id | string | Yes | 辨識摘要的識別碼。 摘要提供者實作會使用此字串來判斷或指定每個作業所參考的應用程式摘要。 對於應用程式資訊清單檔案內定義的所有摘要,此字串必須是唯一的。 | N/A |
DisplayName | 字串 | Yes | Widgets Board 上顯示的摘要名稱。 | N/A |
說明 | string | Yes | 摘要的簡短描述。 | N/A |
ContentUri | 字串 | Yes | 從中擷取摘要內容的 URI。 | N/A |
圖示 | 字串 | Yes | Widgets Board 中顯示的圖示影像檔套件相對路徑。 | N/A |
WebRequestFilter | 字串 | No | 一個 Web 請求篩選器字串,指定一組 URL,資源請求將重新導向至 Feed 提供者的 IFeedResourceProvider 實作。 使用 Match Patterns 中所述的格式來表達模式。 註冊中的篩選字串必須在必要時使用 Punycode 。 所有內容類型在匹配時都會被重定向,因此篩選器應僅解析為透過應用程式中的 IFeedResourceProvider 取得的內容。 | N/A |
ExcludedRegions | 字串 | No | 不應使用摘要的區域清單。 摘要可以指定 ExcludedRegions 或 ExclusiveRegions,但不能在單一摘要定義中同時指定這兩者。 屬性的值是兩個字元區域代碼的逗號分隔清單。 | N/A |
ExclusiveRegions | 字串 | No | 唯一可用的摘要區域清單。 摘要可以指定 ExcludedRegions 或 ExclusiveRegions,但不能在單一摘要定義中指定這兩者。 屬性的值是兩個字元區域代碼的逗號分隔清單。 | N/A |
您可以使用當地語系化的資源,而不是 UI 面向屬性值的字串常值。 如需詳細資料,請參閱將您 UI 和應用程式套件資訊清單中的字串當地語系化。
範例
下列程式碼範例說明摘要套件資訊清單 XML 格式的使用方式。
<uap3:AppExtension Name="com.microsoft.windows.widgets.feeds" DisplayName="ContosoApp" Id="ContosoApp" PublicFolder="Public">
<uap3:Properties>
<FeedProvider Description="ms-resource:ProviderDescription" Icon="ms-appx:Images\ContosoProviderIcon.png">
<Activation>
<CreateInstance ClassId="ECB883FD-3755-4E1C-BECA-D3397A3FF15C" />
</Activation>
<Definitions>
<Definition Id="Contoso_Feed"
DisplayName="ms-resource:FeedDisplayName"
Description="ms-resource:FeedDescription"
ContentUri="https://contoso.com/news"
Icon="ms-appx:Images\ContosoFeedIcon.png"
WebRequestFilter="https://contoso.com/*/feed/appResource/*"
ExcludedRegions="FR,DE,IT">
</Definition>
</Definitions>
</FeedProvider>
</uap3:Properties>
</uap3:AppExtension>