Compartilhar via


Formato XML do manifesto do pacote do provedor de feed

Observação

Algumas informações relacionam-se ao produto de pré-lançamento, o qual poderá ser substancialmente modificado antes do lançamento comercial. A Microsoft não oferece nenhuma garantia, explícita ou implícita, quanto às informações fornecidas aqui.

Para serem exibidos no Quadro de Widgets, os aplicativos que dão suporte aos feeds do Windows precisam registrar o provedor de feed no sistema. Atualmente, aplicativos Win32 só são compatíveis com aplicativos empacotados, e os provedores de feed especificam as informações de registro no arquivo de manifesto do pacote do aplicativo. Este artigo documenta o formato XML para o registro de feed. Confira a seção Exemplo para ver uma listagem de código de um exemplo de manifesto do pacote para um provedor de feed do Win32.

Extensão de aplicativo

O arquivo de manifesto do pacote do aplicativo dá suporte a várias extensões e recursos diferentes para aplicativos do Windows. O formato do manifesto do pacote do aplicativo é definido por um conjunto de esquemas documentados na Referência de esquemas de manifesto do pacote. Os provedores de feed declaram as informações de registro no uap3:AppExtension. O atributo Name da extensão precisa ser definido como "com.microsoft.windows.widgets.feeds".

Os provedores de feed devem incluir uap3:Properties como o filho de uap3:AppExtension. O esquema de manifesto do pacote não impõe a estrutura do elemento uap3:Properties, a não ser a exigência de um XML bem formado. O restante deste artigo descreve o formato XML esperado pelo Quadro de Widgets para registrar um provedor de feed com sucesso.

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

Hierarquia de elementos

FeedProvider

  Ativação

    CreateInstance

  Definições

    Definição

FeedProvider

O elemento raiz das informações de registro do provedor de feed.

Atributo Tipo Obrigatória Descrição Valor padrão
Descrição string Sim Uma breve descrição do provedor de feed. N/D
DisplayName string Sim O nome do provedor de feed que é exibido no Quadro de Widgets. N/D
Ícone string Sim O caminho relativo ao pacote para um arquivo de imagem de ícone que é exibido no Quadro de Widgets. N/D
Id cadeia de caracteres Sim Uma ID que identifica o provedor de feed. As implementações do provedor de feed usam essa sequência para determinar ou especificar os provedores de feed do aplicativo que estão sendo referenciados para cada operação. Essa sequência precisa ser exclusiva para todos os provedores de feed definidos no arquivo de manifesto do aplicativo. N/D

Ativação

Especifica informações de ativação do provedor de feed.

CreateInstance

CreateInstance deve ser especificado para provedores de feed baseados em Win32 que implementem a interface IFeedProvider. O sistema ativará a interface com uma chamada a CoCreateInstance. O atributo ClassId especifica o CLSID para o servidor CreateInstance que implementa a interface IFeedProvider.

Atributo Tipo Obrigatória Descrição Valor padrão
ClassId GUID Sim O CLSID do servidor CreateInstance que implementa o provedor de feed. N/D

Definições

O elemento de contêiner de um ou mais registros de feed.

Definição

Representa o registro de um só feed.

Atributo Tipo Obrigatória Descrição Valor padrão
Id cadeia de caracteres Sim Uma ID que identifica o feed. As implementações do provedor de feed usam essa sequência para determinar ou especificar os feeds do aplicativo que estão sendo referenciados para cada operação. Essa sequência precisa ser exclusiva para todos os feeds definidos no arquivo de manifesto do aplicativo. N/D
DisplayName string Sim O nome do feed exibido no Quadro de Widgets. N/D
Descrição string Sim Uma descrição breve do feed. N/D
ContentUri string Sim O URI do qual o conteúdo do feed é recuperado. N/D
Ícone string Sim O caminho relativo ao pacote para um arquivo de imagem de ícone que é exibido no Quadro de Widgets. N/D
WebRequestFilter string Não Uma cadeia de caracteres de filtro de solicitação da Web especificando o conjunto de URLs para o qual as solicitações de recursos serão redirecionadas para a implementação de IFeedResourceProvider do provedor de feed. O padrão é expresso usando o formato descrito em Padrões de correspondência. A cadeia de caracteres de filtro no registro deve usar Punycode quando necessário. Todos os tipos de conteúdo serão redirecionados quando correspondidos, portanto, o filtro só deve ser resolvido para o conteúdo destinado a ser obtido por meio de IFeedResourceProvider no aplicativo. N/D
Regiões Excluídas string Não Uma lista de regiões onde o feed não deve estar disponível. Os feeds podem especificar ExcludedRegions ou ExclusiveRegions, mas não devem especificar ambos em uma única definição de feed. O valor do atributo é uma lista separada por vírgulas de dois códigos de região de caracteres. N/D
Regiões Exclusivas string Não Uma lista das únicas regiões onde o feed deve estar disponível. Os feeds podem especificar ExcludedRegions ou ExclusiveRegions, mas não devem especificar ambos na definição de feed único. O valor do atributo é uma lista separada por vírgulas de dois códigos de região de caracteres. N/D

Você pode usar recursos localizados em vez de literais de cadeia de caracteres para os valores de atributo voltados para a interface do usuário. Para obter mais informações, confira Localizar as sequências em sua interface do usuário e o manifesto do pacote do aplicativo.

Exemplo

O exemplo de código a seguir ilustra o uso do formato XML do manifesto do pacote de feed.

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