Class NotificationManager

Definition

Namespace:: Tizen.Applications.Notifications

Assembly:: Tizen.Applications.Notification.dll

NotificationManager class to post, update, delete, and get notification.


                C#
                
                    Copy
                    
                
            
public static class NotificationManager

Inheritance: object

NotificationManager

Methods

View Source

Delete(Notification)

Deletes a posted notification.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Delete(Notification notification)

Parameters

Type	Name	Description
Notification	notification	Notification to remove.

Examples


                
                
                    Copy
                    
                
            
Notification notification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = "first notification"
};
NotificationManager.Post(notification);

    // do something

NotificationManager.Delete(notification);

Exceptions

Type	Condition
System.ArgumentException	Thrown when an argument is invalid.
System.UnauthorizedAccessException	Thrown in case of a permission is denied.
System.InvalidOperationException	Thrown in case of any internal error.

View Source

DeleteAll()

Removes all posted notifications of calling application.

Declaration


                C#
                
                    Copy
                    
                
            
public static void DeleteAll()

Examples


                
                
                    Copy
                    
                
            
Notification firstNotification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = "first notification"
};
NotificationManager.Post(firstNotification);

Notification secondNotification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = "second notification"
};
NotificationManager.Post(secondNotification);
NotificationManager.DeleteAll();

Exceptions

Type	Condition
System.UnauthorizedAccessException	Thrown in case of a permission is denied.
System.InvalidOperationException	Thrown in case of any internal error.

View Source

GetBlockState()

Gets notification block state.

Declaration


                C#
                
                    Copy
                    
                
            
public static NotificationBlockState GetBlockState()

Returns

Type	Description
NotificationBlockState	NotificationBlockState is a state if notification is posted.

Remarks

The user can set the notification block state in settings. The block state indicates whether or not notifications can be posted. Additionally, only notifications to the notification panel are allowed in "Do not disturb mode". Sound, vibrate, and active notifications are blocked.

Exceptions

Type	Condition
System.UnauthorizedAccessException	Thrown in case of a permission is denied.
System.InvalidOperationException	Thrown in case of any internal error.

View Source

Load(string)

Searches for a posted notification which has the specified tag and has not been deleted yet.

Declaration


                C#
                
                    Copy
                    
                
            
public static Notification Load(string tag)

Parameters

Type	Name	Description
string	tag	Tag used to query.

Returns

Type	Description
Notification	Notification Object with specified tag.

Remarks

Load method should be called only for notifications, which have been posted using the NotificationManager.Post method. If two or more notifications share the same tag, the notification posted most recently is returned.

Examples


                
                
                    Copy
                    
                
            
Notification notification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = "first notification"
};
NotificationManager.Post(notification);

    // do someting

Notification loadNotification = NotificationManager.Load("first notification");

Exceptions

Type	Condition
System.ArgumentException	Throwing the same exception when argument is invalid and when the tag does not exist is misleading.
System.UnauthorizedAccessException	Thrown in case of permission denied.
System.InvalidOperationException	Thrown in case of any internal error.

View Source

LoadTemplate(string)

Loads a notification template from the notification database.

Declaration


                C#
                
                    Copy
                    
                
            
public static Notification LoadTemplate(string name)

Parameters

Type	Name	Description
string	name	Template name.

Returns

Type	Description
Notification	Notification Object with inputted template name.

Examples


                
                
                    Copy
                    
                
            
Notification notification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = "first notification"
};

Notification.Accessory accessory = new Notification.Accessory
{
    LedOption = AccessoryOption.On,
    VibrationOption = AccessoryOption.Custom,
    VibrationPath = "vibration absolute path"
}
notification.setAccessory(accessory);

    // do something

NotificationManager.Post(notification);

Notification.LockStyle style = new Notification.LockStyle
{
    IconPath = "icon path",
    ThumbnailPath = "Thumbnail path"
}
notification.AddStyle(style);
NotificationManager.SaveTemplate(notification, "firstTemplate");
Notification notificationTemplate = NotificationManager.LoadTemplate("firstTemplate");

Exceptions

Type	Condition
System.ArgumentException	Throwing the same exception when argument is invalid and when the template does not exist is misleading.
System.UnauthorizedAccessException	Thrown in case of permission denied.
System.InvalidOperationException	Thrown in case of any internal error.

View Source

Post(Notification)

Posts a new notification.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Post(Notification notification)

Parameters

Type	Name	Description
Notification	notification	Notification to post.

Examples


                
                
                    Copy
                    
                
            
Notification notification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = "first notification"
};

Notification.AccessorySet accessory = new Notification.AccessorySet
{
    SoundOption = AccessoryOption.On,
    CanVibrate = true
};
notification.Accessory = accessory;

    // do something

NotificationManager.Post(notification);

Exceptions

Type	Condition
System.ArgumentException	Thrown when an argument is invalid.
System.UnauthorizedAccessException	Thrown in case of a permission is denied.
System.InvalidOperationException	Thrown in case of any internal error.

View Source

SaveTemplate(Notification, string)

Saves a notification template to the notification database.

Declaration


                C#
                
                    Copy
                    
                
            
public static void SaveTemplate(Notification notification, string name)

Parameters

Type	Name	Description
Notification	notification	Notification to save as template.
string	name	Template name.

Examples


                
                
                    Copy
                    
                
            
Notification notification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = "first notification"
};

Notification.Accessory accessory = new Notification.Accessory
{
    LedOption = AccessoryOption.On,
    VibrationOption = AccessoryOption.Custom,
    VibrationPath = "vibration absolute path"
}
notification.setAccessory(accessory);

    // do something

NotificationManager.Post(notification);

Notification.LockStyle style = new Notification.LockStyle
{
    IconPath = "icon path",
    ThumbnailPath = "Thumbnail path"
}
notification.AddStyle(style);
NotificationManager.SaveTemplate(notification, "firstTemplate");

Exceptions

Type	Condition
System.ArgumentException	Thrown when an argument is invalid.
System.UnauthorizedAccessException	Thrown in case of a permission is denied.
System.InvalidOperationException	Thrown when it can't be saved as a template.

View Source

Update(Notification)

Updates a posted notification.

Declaration


                C#
                
                    Copy
                    
                
            
public static void Update(Notification notification)

Parameters

Type	Name	Description
Notification	notification	Notification to update.

Examples


                
                
                    Copy
                    
                
            
string tag = "first tag";

Notification notification = new Notification
{
    Title = "title",
    Content = "content",
    Icon = "absolute icon path",
    Tag = tag
};

Notification.AccessorySet accessory = new Notification.AccessorySet
{
    LedOption = AccessoryOption.On,
    VibrationOption = AccessoryOption.Custom,
    VibrationPath = "vibration absolute path"
}
notification.Accessory = accessory;

NotificationManager.Post(notification);

    // do something

Notification loadNotification = NotificationManager.Load(tag);

loadNotification.Progress = new ProgressType(ProgressCategory.Percent, 0.0. 100.0);

Thread thread = new Thread(new ParameterizedThreadStart(UpdateProgress));
thread.IsBackground = true;
thread.Start(notification);

  ...

static void UpdateProgress(Object obj)
{
    Notification notification = (Notification)obj;

    for (double current = 1.0; current <= 100.0; current = current + 1.0)
    {
        notification.Progress.ProgressCurrent = current;
        NotificationManager.Update(notification);
        Thread.Sleep(300);
    }
}

Exceptions

Type	Condition
System.ArgumentException	Thrown when an argument is invalid.
System.UnauthorizedAccessException	Thrown in case of a permission is denied.
System.InvalidOperationException	Thrown in case of any internal error.