Freigeben über

XML-Format des Feedanbieter-Paketmanifests

  • Artikel

Hinweis

Einige Informationen beziehen sich auf Vorabversionen, die vor der kommerziellen Freigabe grundlegend geändert werden können. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Um auf dem Widgets Board angezeigt zu werden, müssen Apps, die Windows-Feeds unterstützen, ihren Feedanbieter beim System registrieren. Für Win32-Apps werden derzeit nur gepackte Apps unterstützt, und Feedanbieter geben ihre Registrierungsinformationen in der App-Paketmanifestdatei an. In diesem Artikel wird das XML-Format für die Feed-Registrierung dokumentiert. Im Abschnitt Beispiel finden Sie eine Codeliste eines Beispielpaketmanifests für einen Win32-Feedanbieter.

App-Erweiterung

Die App-Paketmanifestdatei unterstützt viele verschiedene Erweiterungen und Features für Windows-Apps. Das Format des App-Paketmanifests wird durch eine Reihe von Schemas definiert, die in der Paketmanifestschemareferenz dokumentiert sind. Feedanbieter deklarieren ihre Registrierungsinformationen in uap3:AppExtension. Das Name-Attribut der Erweiterung muss auf „com.microsoft.windows.widgets.feeds“ festgelegt werden.

Feedanbieter sollten uap3:Properties als untergeordnetes Element von uap3:AppExtension einschließen. Das Paketmanifest-Schema erzwingt nicht die Struktur des uap3:Properties-Elements, außer dass wohlgeformte XML-Dateien erforderlich sind. Im weiteren Verlauf dieses Artikels wird das XML-Format beschrieben, das das Widgets Board erwartet, um einen Feedanbieter erfolgreich zu registrieren.

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

Elementhierarchie

FeedProvider

  Aktivierung

    CreateInstance

  Definitionen

    Definition

FeedProvider

Das Stammelement der Registrierungsinformationen des Feedanbieters.

Attribute Typ Erforderlich Beschreibung Standardwert
Beschreibung Zeichenfolge Ja Eine kurze Beschreibung des Feedanbieters. N/V
DisplayName Zeichenfolge Ja Der Name des Feedanbieters, der auf dem Widgets Board angezeigt wird. N/V
Symbol: Zeichenfolge Ja Der paketbezogene Pfad zu einer Symbol-Bilddatei, die im Widgets Board angezeigt wird. N/V
Id Zeichenfolge Ja Eine ID, die den Feedanbieter identifiziert. Feedanbieter-Implementierungen verwenden diese Zeichenfolge, um zu bestimmen oder anzugeben, auf welche der Feedanbieter der App bei den einzelnen Vorgängen verwiesen wird. Diese Zeichenkette muss für alle in der App-Manifestdatei definierten Feedanbieter eindeutig sein. N/V

Aktivierung

Gibt Aktivierungsinformationen für den Feedanbieter an.

CreateInstance

CreateInstance sollte für Win32-basierte Feedanbieter angegeben werden, die die IFeedProvider-Schnittstelle implementieren. Das System aktiviert die Schnittstelle mit einem Aufruf von CoCreateInstance. Das ClassId-Attribut gibt die CLSID für den CreateInstance-Server an, der die IFeedProvider-Schnittstelle implementiert.

Attribute Typ Erforderlich Beschreibung Standardwert
ClassId GUID Ja Die CLSID für den CreateInstance-Server, der den Feedanbieter implementiert. N/V

Definitionen

Das Containerelement für mindestens eine Feed-Registrierung.

Definition

Stellt die Registrierung für einen einzelnen Feed dar.

Attribute Typ Erforderlich Beschreibung Standardwert
Id Zeichenfolge Ja Eine eindeutige ID, die den Feed identifiziert. Feedanbieter-Implementierungen verwenden diese Zeichenfolge, um zu bestimmen oder anzugeben, auf welche der App-Feeds bei den einzelnen Vorgängen verwiesen wird. Diese Zeichenfolge muss für alle in der App-Manifestdatei definierten Feeds eindeutig sein. N/V
DisplayName Zeichenfolge Ja Der Name des Feeds, der auf dem Widgets Board angezeigt wird. N/V
Beschreibung Zeichenfolge Ja Eine kurze Beschreibung des Feeds. N/V
contentUri Zeichenfolge Ja Der URI, aus dem Feed-Inhalte abgerufen werden. N/V
Symbol: Zeichenfolge Ja Der paketbezogene Pfad zu einer Symbol-Bilddatei, die im Widgets Board angezeigt wird. N/V
WebRequestFilter Zeichenfolge No Eine Webanforderungs-Filterzeichenfolge, die den Satz von URLs angibt, für die die Ressourcenanforderungen an die Implementierung des Feed-Providers IFeedResourceProvider umgeleitet werden. Das Muster wird in dem Format ausgedrückt, das in Match Patterns beschrieben ist. Die Filterzeichenfolge in der Registrierung muss Punycode verwenden, wo dies erforderlich ist. Alle Inhaltstypen werden beim Abgleich umgeleitet, so dass der Filter nur Inhalte auflösen sollte, die über den IFeedResourceProvider in der Anwendung bezogen werden sollen. N/V
Ausgeschlossene Regionen Zeichenfolge No Eine Liste der Regionen, in denen der Feed nicht verfügbar sein sollte. Feeds können "ExcludedRegions" oder "ExclusiveRegions" angeben, dürfen jedoch nicht beide in einer einzelnen Feeddefinition angeben. Der Wert des Attributs ist eine durch Trennzeichen getrennte Liste mit zwei Zeichenbereichscodes. N/V
ExclusiveRegions Zeichenfolge No Eine Liste der einzigen Regionen, in denen der Feed verfügbar sein soll. Feeds können "ExcludedRegions" oder "ExclusiveRegions" angeben, dürfen jedoch nicht beide in der Einzelfeeddefinition angeben. Der Wert des Attributs ist eine durch Trennzeichen getrennte Liste mit zwei Zeichenbereichscodes. N/V

Sie können lokalisierte Ressourcen anstelle von Zeichenfolgenliteralen für die UI-bezogenen Attributwerte verwenden. Weitere Informationen finden Sie unter Lokalisieren von Zeichenfolgen in der Benutzeroberfläche und im Paketmanifest der App.

Beispiel

Im folgenden Codebeispiel wird die Verwendung des XML-Formats des Feed-Paketmanifests veranschaulicht.

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