Mengelompokkan pemberitahuan toast dengan koleksi

2024-06-14

Gunakan koleksi untuk mengatur roti panggang aplikasi Anda di Pusat Tindakan. Koleksi membantu pengguna menemukan informasi dalam Pusat Tindakan dengan lebih mudah dan memungkinkan pengembang mengelola pemberitahuan mereka dengan lebih baik. API di bawah ini memungkinkan penghapusan, pembuatan, dan pembaruan koleksi pemberitahuan.

Penting

Memerlukan Pembaruan Pembuat: Anda harus menargetkan SDK 15063 dan menjalankan build 15063 atau yang lebih baru untuk menggunakan koleksi toast. API terkait termasuk Windows.UI.Notifications.ToastCollection, dan Windows.UI.Notifications.ToastCollectionManager

Anda dapat melihat contoh di bawah ini dengan aplikasi olahpesan yang memisahkan pemberitahuan berdasarkan grup obrolan; setiap judul (Comp Sci 160A Project Chat, Direct Messages, Lacrosse Team Chat) adalah koleksi terpisah. Perhatikan bagaimana pemberitahuan dikelompokkan dengan jelas seolah-olah mereka berasal dari aplikasi terpisah, meskipun semuanya adalah pemberitahuan dari aplikasi yang sama. Jika Anda mencari cara yang lebih halus untuk mengatur pemberitahuan Anda, lihat header toast.
Contoh Koleksi dengan dua Grup Pemberitahuan yang berbeda

Membuat koleksi

Saat membuat setiap koleksi, Anda diharuskan untuk memberikan nama tampilan dan ikon, yang ditampilkan di dalam Pusat Tindakan sebagai bagian dari judul koleksi, seperti yang ditunjukkan pada gambar di atas. Koleksi juga memerlukan argumen peluncuran untuk membantu aplikasi menavigasi ke lokasi yang tepat dalam aplikasi saat judul koleksi diklik oleh pengguna.

Membuat kumpulan

// Create a toast collection
public async void CreateToastCollection()
{
	string displayName = "Work Email"; 
	string launchArg = "NavigateToWorkEmailInbox"; 
	Uri icon = new Windows.Foundation.Uri("ms-appx:///Assets/workEmail.png");

	// Constructor
	ToastCollection workEmailToastCollection = new ToastCollection(
		"MyToastCollection", 
		displayName,
 		launchArg, 
		icon);

	// Calls the platform to create the collection
	await ToastNotificationManager.GetDefault().GetToastCollectionManager().SaveToastCollectionAsync(workEmailToastCollection);  								
}

Mengirim pemberitahuan ke koleksi

Kami akan membahas pengiriman pemberitahuan dari tiga alur toast yang berbeda: lokal, terjadwal, dan dorong. Untuk masing-masing contoh ini, kita akan membuat roti panggang sampel untuk dikirim dengan kode tepat di bawah ini, maka kita akan fokus pada cara menambahkan toast ke koleksi melalui setiap alur.

Buat konten roti panggang:

// Construct the content
var content = new ToastContentBuilder()
	.AddText("Adam sent a message to the group")
	.GetToastContent();

Mengirim roti panggang ke koleksi

// Create the toast
ToastNotification toast = new ToastNotification(content.GetXml());

// Get the collection notifier
var notifier = await ToastNotificationManager.GetDefault().GetToastNotifierForToastCollectionIdAsync("MyToastCollection");

// And show the toast
notifier.Show(toast);

Menambahkan roti panggang terjadwal ke koleksi

// Create scheduled toast from XML above
ScheduledToastNotification scheduledToast = new ScheduledToastNotification(content.GetXml(), DateTimeOffset.Now.AddSeconds(10));

// Get notifier
var notifier = await ToastNotificationManager.GetDefault().GetToastNotifierForToastCollectionIdAsync("MyToastCollection");
    
// Add to schedule
notifier.AddToSchedule(scheduledToast);

Mengirim toast pendorongan ke koleksi

Untuk toast push, Anda perlu menambahkan header X-WNS-CollectionId ke pesan POST.

// Add header to HTTP request
request.Headers.Add("X-WNS-CollectionId", collectionId);

Mengelola koleksi

Membuat manajer koleksi roti panggang

Untuk cuplikan kode lainnya di bagian 'Mengelola Koleksi' ini, kami akan menggunakan collectionManager di bawah ini.

ToastCollectionManger collectionManager = ToastNotificationManager.GetDefault().GetToastCollectionManager();

Mendapatkan semua koleksi

IReadOnlyList<ToastCollection> collections = await collectionManager.FindAllToastCollectionsAsync();

Mendapatkan jumlah koleksi yang dibuat

int toastCollectionCount = (await collectionManager.FindAllToastCollectionsAsync()).Count;

Menghapus koleksi

await collectionManager.RemoveToastCollectionAsync("MyToastCollection");

Memperbarui koleksi

Anda dapat memperbarui koleksi dengan membuat koleksi baru dengan ID yang sama dan menyimpan instans baru koleksi.

string displayName = "Updated Display Name"; 
string launchArg = "UpdatedLaunchArgs"; 
Uri icon = new Windows.Foundation.Uri("ms-appx:///Assets/updatedPicture.png");

// Construct a new toast collection with the same collection id
ToastCollection updatedToastCollection = new ToastCollection(
	"MyToastCollection", 
	displayName,
	launchArg, 
	icon);

// Calls the platform to update the collection by saving the new instance
await collectionManager.SaveToastCollectionAsync(updatedToastCollection);

Mengelola roti panggang dalam koleksi

Properti grup dan tag

Properti grup dan tag secara unik mengidentifikasi pemberitahuan dalam koleksi. Grup (dan Tag) berfungsi sebagai kunci primer komposit (lebih dari satu pengidentifikasi) untuk mengidentifikasi pemberitahuan Anda. Misalnya, jika Anda ingin menghapus atau mengganti pemberitahuan, Anda harus dapat menentukan pemberitahuan apa yang ingin Anda hapus/ganti; Anda melakukannya dengan menentukan Tag dan Grup. Contohnya adalah aplikasi olahpesan. Pengembang dapat menggunakan ID percakapan sebagai Grup, dan ID pesan sebagai Tag.

Menghapus roti panggang dari koleksi

Anda dapat menghapus roti panggang individual menggunakan tag dan ID grup, atau menghapus semua roti panggang dalam koleksi.

// Get the history
var collectionHistory = await ToastNotificationManager.GetDefault().GetHistoryForToastCollectionAsync("MyToastCollection");

// Remove toast
collectionHistory.Remove(tag, group);

Menghapus semua roti panggang dalam koleksi

// Get the history
var collectionHistory = await ToastNotificationManager.GetDefault().GetHistoryForToastCollectionAsync("MyToastCollection");

// Remove toast
collectionHistory.Clear();

Koleksi di Visualizer Pemberitahuan

Anda dapat menggunakan alat Notifications Visualizer untuk membantu merancang koleksi Anda. Ikuti langkah berikut:

Klik ikon gigi di sudut kanan bawah.
Pilih 'Koleksi toast'.
Di atas pratinjau roti panggang, ada menu dropdown 'Koleksi Toast'. Pilih kelola koleksi.
Klik 'Tambahkan koleksi', isi detail untuk koleksi, dan simpan.
Anda dapat menambahkan lebih banyak koleksi, atau mengklik kotak kelola koleksi untuk kembali ke layar utama.
Pilih koleksi yang ingin Anda tambahkan toast ke dari menu dropdown 'Koleksi Toast'.
Ketika Anda menembakkan roti panggang, toast akan ditambahkan ke koleksi yang sesuai di Pusat Tindakan.

Detail lainnya

Koleksi roti panggang yang Anda buat juga akan tercermin dalam pengaturan pemberitahuan pengguna. Pengguna dapat mengaktifkan atau menonaktifkan pengaturan untuk setiap koleksi individual untuk mengaktifkan atau menonaktifkan subgrup ini. Jika pemberitahuan dimatikan di tingkat atas untuk aplikasi, maka semua pemberitahuan koleksi juga akan dinonaktifkan. Selain itu, setiap koleksi secara default akan menampilkan 3 pemberitahuan di Pusat Tindakan, dan pengguna dapat memperluasnya untuk menampilkan hingga 20 pemberitahuan.