Bagikan melalui


Format XML manifes paket penyedia umpan

Catatan

Beberapa informasi berkaitan dengan produk yang telah dirilis sebelumnya, yang mungkin dimodifikasi secara substansial sebelum dirilis secara komersial. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.

Untuk ditampilkan di Papan Widget, aplikasi yang mendukung umpan Windows harus mendaftarkan penyedia umpan mereka dengan sistem. Untuk aplikasi Win32, hanya aplikasi paket yang saat ini didukung dan penyedia umpan menentukan informasi pendaftaran mereka dalam file manifes paket aplikasi. Artikel ini mendanai format XML untuk pendaftaran umpan. Lihat bagian Contoh untuk daftar kode manifes paket contoh untuk penyedia umpan Win32.

Ekstensi aplikasi

File manifes paket aplikasi mendukung banyak ekstensi dan fitur yang berbeda untuk aplikasi Windows. Format manifes paket aplikasi didefinisikan oleh sekumpulan skema yang didokumentasikan dalam referensi skema manifes paket. Penyedia umpan menyatakan informasi pendaftaran mereka dalam uap3:AppExtension. Atribut Nama ekstensi harus diatur ke "com.microsoft.windows.widgets.feeds".

Penyedia umpan harus menyertakan uap3:Properties sebagai anak dari uap3:AppExtension. Skema manifes paket tidak memberlakukan struktur elemen uap3:Properties selain membutuhkan XML yang terbentuk dengan baik. Sisa artikel ini menjelaskan format XML yang diharapkan Papan Widget agar berhasil mendaftarkan penyedia umpan.

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

Hierarki elemen

FeedProvider

  Aktivasi

    CreateInstance

  Definisi

    Definisi

FeedProvider

Elemen akar dari informasi pendaftaran penyedia umpan.

Atribut Jenis Wajib Deskripsi Nilai default
Keterangan string Ya Deskripsi singkat tentang penyedia umpan. T/A
DisplayName string Ya Nama penyedia umpan yang ditampilkan di Papan Widget. T/A
Ikon string Ya Jalur relatif paket ke file gambar ikon yang ditampilkan di Papan Widget. T/A
Id string Ya ID yang mengidentifikasi penyedia umpan. Implementasi penyedia umpan menggunakan string ini untuk menentukan atau menentukan penyedia umpan aplikasi mana yang sedang dirujuk untuk setiap operasi. String ini harus unik untuk semua penyedia umpan yang ditentukan dalam file manifes aplikasi. T/A

Aktivasi

Menentukan informasi aktivasi untuk penyedia umpan.

CreateInstance

CreateInstance harus ditentukan untuk penyedia umpan berbasis Win32 yang mengimplementasikan antarmuka IFeedProvider . Sistem akan mengaktifkan antarmuka dengan panggilan ke CoCreateInstance. Atribut ClassId menentukan CLSID untuk server CreateInstance yang mengimplementasikan antarmuka IFeedProvider .

Atribut Jenis Wajib Deskripsi Nilai default
ClassId GUID Ya CLSID untuk server CreateInstance yang mengimplementasikan penyedia umpan. T/A

Definisi

Elemen kontainer untuk satu atau beberapa pendaftaran umpan.

Definisi

Mewakili pendaftaran untuk satu umpan.

Atribut Jenis Wajib Deskripsi Nilai default
Id string Ya ID yang mengidentifikasi umpan. Implementasi penyedia umpan menggunakan string ini untuk menentukan atau menentukan umpan aplikasi mana yang dirujuk untuk setiap operasi. String ini harus unik untuk semua umpan yang ditentukan dalam file manifes aplikasi. T/A
DisplayName string Ya Nama umpan yang ditampilkan di Papan Widget. T/A
Keterangan string Ya Deskripsi singkat tentang umpan. T/A
ContentUri string Ya URI tempat konten umpan diambil. T/A
Ikon string Ya Jalur relatif paket ke file gambar ikon yang ditampilkan di Papan Widget. T/A
WebRequestFilter string No String filter permintaan web yang menentukan kumpulan URL yang permintaan sumber dayanya akan dialihkan ke implementasi IFeedResourceProvider penyedia umpan. Pola dinyatakan menggunakan format yang dijelaskan dalam Pola Pencocokan. String filter dalam pendaftaran harus menggunakan Punycode jika perlu. Semua jenis konten akan dialihkan ketika dicocokkan sehingga filter hanya boleh diselesaikan ke konten yang dimaksudkan untuk diperoleh melalui IFeedResourceProvider dalam aplikasi. T/A
ExcludedRegions string No Daftar wilayah tempat umpan tidak boleh tersedia. Umpan dapat menentukan ExcludedRegions atau ExclusiveRegions tetapi tidak boleh menentukan keduanya dalam satu definisi umpan. Nilai atribut adalah daftar yang dipisahkan koma dari dua kode wilayah karakter. T/A
ExclusiveRegions string No Daftar satu-satunya wilayah tempat umpan harus tersedia. Umpan dapat menentukan ExcludedRegions atau ExclusiveRegions tetapi tidak boleh menentukan keduanya dalam definisi umpan tunggal. Nilai atribut adalah daftar yang dipisahkan koma dari dua kode wilayah karakter. T/A

Anda dapat menggunakan sumber daya yang dilokalkan alih-alih literal string untuk nilai atribut yang menghadap UI. Untuk informasi selengkapnya, lihat Melokalisasi string di manifes paket UI dan aplikasi Anda.

Contoh

Contoh kode berikut mengilustrasikan penggunaan format XML manifes paket umpan.

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