Поделиться через

Формат XML манифеста пакета поставщика веб-каналов

  • Статья

Примечание.

Некоторые сведения относятся к предварительной версии продукта, в которую перед коммерческим выпуском могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.

Чтобы отобразиться в доске мини-приложений, которые поддерживают веб-каналы Windows, должны зарегистрировать поставщика веб-каналов в системе. Для приложений Win32 в настоящее время поддерживаются только упакованные приложения, а поставщики веб-каналов указывают сведения о регистрации в файле манифеста пакета приложения. В этой статье описан формат XML для регистрации веб-канала. См. раздел "Пример" для описания кода примера манифеста пакета для поставщика веб-канала Win32.

Расширение приложения

Файл манифеста пакета приложения поддерживает множество различных расширений и функций для приложений Windows. Формат манифеста пакета приложения определяется набором схем, которые описаны в справочнике по схеме манифеста пакета. Поставщики веб-каналов объявляют свои сведения о регистрации в uap3:AppExtension. Атрибут Name расширения должен иметь значение com.microsoft.windows.widgets.feeds.

Поставщики веб-каналов должны включать uap3 :Properties в качестве дочернего элемента uap3:AppExtension. Схема манифеста пакета не применяет структуру элемента uap3:Properties, отличного от необходимости хорошо сформированного XML. В остальной части этой статьи описывается 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

Корневой элемент сведений о регистрации поставщика веб-канала.

Атрибут Тип Обязательно Описание Default value
Description string Да Краткое описание поставщика веб-канала. Н/П
Отображаемое имя строка Да Имя поставщика веб-канала, отображаемого на панели мини-приложений. Н/П
Значок строка Да Относительный путь к файлу изображения значка, отображаемого в доске мини-приложений. Н/П
Id string Да Идентификатор, определяющий поставщика веб-канала. Реализации поставщика веб-каналов используют эту строку, чтобы определить или указать, какие поставщики веб-каналов приложения ссылаются для каждой операции. Эта строка должна быть уникальной для всех поставщиков веб-каналов, определенных в файле манифеста приложения. Н/П

Активация

Указывает сведения о активации для поставщика веб-канала.

CreateInstance

CreateInstance следует указать для поставщиков веб-каналов на основе Win32, реализующих интерфейс IFeedProvider . Система активирует интерфейс с вызовом CoCreateInstance. Атрибут ClassId задает CLSID для сервера CreateInstance, реализующего интерфейс IFeedProvider.

Атрибут Тип Обязательно Описание Default value
ClassId GUID Да CLSID для сервера CreateInstance, реализующего поставщик веб-канала. Н/П

Определения

Элемент контейнера для одной или нескольких регистраций веб-канала.

Определение

Представляет регистрацию для одного веб-канала.

Атрибут Тип Обязательно Описание Default value
Id string Да Идентификатор, определяющий веб-канал. Реализации поставщика веб-каналов используют эту строку, чтобы определить или указать, какие веб-каналы приложения ссылаются для каждой операции. Эта строка должна быть уникальной для всех веб-каналов, определенных в файле манифеста приложения. Н/П
Отображаемое имя строка Да Имя веб-канала, отображаемого на панели мини-приложений. Н/П
Description string Да Краткое описание веб-канала. Н/П
ContentUri строка Да URI, из которого извлекается содержимое веб-канала. Н/П
Значок строка Да Относительный путь к файлу изображения значка, отображаемого в доске мини-приложений. Н/П
WebRequestFilter строка Нет Строка фильтра веб-запроса, указывающая набор URL-адресов, для которых запросы ресурсов будут перенаправлены в реализацию поставщика веб-канала IFeedResourceProvider. Шаблон выражается с помощью формата, описанного в шаблонах сопоставления. При необходимости строка фильтра в регистрации должна использовать Punycode . Все типы контента будут перенаправлены при сопоставлении, поэтому фильтр должен разрешаться только содержимому, который должен быть получен через IFeedResourceProvider в приложении. Н/П
Исключенныеregions строка Нет Список регионов, в которых веб-канал не должен быть доступен. Каналы могут указывать excludedRegions или ExclusiveRegions, но не должны указывать оба в определении одного канала. Значение атрибута — это разделенный запятыми список двух кодов областей символов. Н/П
ExclusiveRegions строка Нет Список единственных регионов, где должен быть доступен веб-канал. Каналы могут указывать excludedRegions или ExclusiveRegions, но не должны указывать оба в определении одного канала. Значение атрибута — это разделенный запятыми список двух кодов областей символов. Н/П

Локализованные ресурсы можно использовать вместо строковых литерала для значений атрибутов, доступных для пользовательского интерфейса. Дополнительные сведения см. в разделе "Локализация строк" в манифесте пользовательского интерфейса и пакета приложения.

Пример

В следующем примере кода показан формат 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>