Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 4.08 KB

system-notifications.md

File metadata and controls

68 lines (45 loc) · 4.08 KB
Raw
description
Your notifications are on your way!

🔔 System Notifications

Nitrocid KS provides a way to show the progress from specific applications or to show the update using a feature called the notifications. The kernel handles the notifications and displays all new notifications in the upper right corner of the screen.

These notifications have the following types:

  • Normal notifications: these notifications contain the title and the description to tell you what you're being notified about.
  • Progress notifications: these notifications contain the title, the description, and the progress data to indicate how much work is being done.
  • Indeterminate progress notifications: these notifications are basically the same as the progress notifications, except that they don't provide any progress information; they just show whether the progress succeeded or failed.

Sending notifications

If you want to send a notification indicating that there is something new, you can make a new Notification instance, specifying the following properties:

  • Notification title
  • Notification description
  • Notification priority
  • Notification type

Each new Notification instance automatically generates a new GUID, which specifies a unique notification ID so that the notifications become distinguishable.

{% hint style="info" %} To make indeterminate progress notifications, you must set the notification type to Progress and set the ProgressIndeterminate property to true prior to sending notifications. The below example shows you how it's done:

var Notif = new Notification(Translate.DoTranslation("Test indeterminate notification"), Translate.DoTranslation("Description is here"), NotificationPriority.Low, NotificationType.Progress)
{
    ProgressIndeterminate = true
};
NotificationManager.NotifySend(Notif);

{% endhint %}

{% hint style="info" %} Progress notifications, determinate or not, are shown asynchronously. You'll have to update the Progress property until it reaches to 100%, depending on the job being done.

Also, it's necessary to change the notification progress state, regardless of whether the operation succeeded or not. The notification system still shows it, either when its Progress property reaches 100%. {% endhint %}

After creating a new instance of Notification, you'll have to use either the NotifySend() function to send a single notification, or the NotifySendRange() function to send a barrage of notifications. This is to ensure that your notification is displayed.

Notification dismissal

If you no longer want a notification to display in the notifications list, you'll need to run the dismissnotif or dismissnotifs command. Similarly, in your mods, you'll have to call either the NotifDismiss() function for a single notification, or the NotifDismissAll() function for all notifications.

After that, the notification should be cleared from the list of recent notifications so that you can keep up with the new updates.

Notification comparison

You can compare between notifications either by using the equals operator == with the two notification instances or by using the Equals() method with the other notification explicitly.

{% hint style="info" %} Even if the two notifications that are to be compared appear to be the same notification, the normal Equals() function also compares the two notification IDs, causing this comparison to return false when you pass two new Notification instances with properties that hold the same values. Therefore, in such situations, you can use the EqualsNoId() function. {% endhint %}

Notification history export

You can also export the recent notifications list by either using the admin shell to invoke a command called savenotifs or, programatically, using a function called SaveRecents() from the notification manager class.

public static void SaveRecents()

Either way, the notification history will be saved to the Nitrocid KS configuration folder under the name of NotificationRecents-n.json, where n indicates how many times the notification history has been exported.