Notification API

Methods

post

Posts a notification to display.

void post(Notification notification);

Since: 2.0

Privilege level: public

Privilege: http://tizen.org/privilege/notification

Parameters:

• notification: A notification to post.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError, if any of the input parameters contain an invalid value.

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type UnknownError, if any other error occurs.

Code example:

try
{
  var appControl = new tizen.ApplicationControl(
      "http://tizen.org/appcontrol/operation/view", null, "image/jpg", null);

  var notificationGroupDict =
  {
    content: "This is a simple user notification.",
    actions: {soundPath: "music/Over the horizon.mp3", vibration: true, appControl: appControl}
  };

  /* Constructs and posts the simple user notification. */
  var notification =
      new tizen.UserNotification("SIMPLE", "User notification", notificationGroupDict);
  tizen.notification.post(notification);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

Code example:

try
{
  var notificationGroupDict =
  {
    content: "This is a thumbnail user notification.",
    thumbnails: {thumbnailIconPath: "images/thumbnail.jpg"}
  };

  /* Constructs and posts the thumbnail user notification. */
  var notification =
      new tizen.UserNotification("THUMBNAIL", "User notification", notificationGroupDict);
  tizen.notification.post(notification);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

Code example:

try
{
  var notificationGroupDict =
  {
    content: "This is an ongoing user notification.",
    images: {iconPath: "images/simple_icon.jpg"}
  };

  /* Constructs and posts the ongoing user notification. */
  var notification =
      new tizen.UserNotification("ONGOING", "User notification", notificationGroupDict);
  tizen.notification.post(notification);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

Code example:

try
{
  var notificationGroupDict =
  {
    content: "This is a progress user notification.",
    textContents: {progressValue: 20},
    actions: {soundPath: "music/Over the horizon.mp3", vibration: false}
  };

  /* Constructs and posts the progress user notification. */
  var notification =
      new tizen.UserNotification("PROGRESS", "User notification", notificationGroupDict);
  tizen.notification.post(notification);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

update

Updates a previously posted notification.

void update(Notification notification);

Since: 2.0

Privilege level: public

Privilege: http://tizen.org/privilege/notification

Parameters:

• notification: A notification to update.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError, if any of the input parameters contain an invalid value.

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type UnknownError, if any other error occurs.

Code example:

try
{
  /* Uses a variable for the previously posted notification. */
  notification.content = "My notification";
  tizen.notification.update(notification);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

remove

Removes a previously posted notification.

void remove(NotificationId id);

Since: 2.0

Privilege level: public

Privilege: http://tizen.org/privilege/notification

Parameters:

• id: A previously posted notification ID to remove.

Exceptions:

• WebAPIException

  • with error type NotFoundError, if NotificationId is not found in the previously posted notification.

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type UnknownError, if any other error occurs.

Code example:

try
{
  /* Uses a variable for the previously posted notification. */
  tizen.notification.remove(notification.id);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

removeAll

Removes all notifications that have been posted by the current application.

void removeAll();

Since: 2.0

Privilege level: public

Privilege: http://tizen.org/privilege/notification

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type UnknownError, if any other error occurs.

Code example:

try
{
  tizen.notification.removeAll();
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

get

Gets a notification that has previously been posted by the current application. Note that the obtained notification's progressType is PERCENTAGE

Deprecated. Deprecated since 4.0. Use getNotification instead.

Notification get(NotificationId id);

Since: 2.0

Remark: This method is designed to return old-style notification.

Parameters:

• id: A previously posted notification ID.

Return value:

Notification: Notification posted previously by the current application.

Exceptions:

• WebAPIException

  • with error type NotFoundError, if NotificationId is not found in the previously posted notifications.

  • with error type UnknownError, if any other error occurs.

Code example:

try
{
  /* Uses a variable for the previously posted notification. */
  /* Saves the notification ID for future use. */
  var myId = notification.id;

  var myNotification = tizen.notification.get(myId);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

getNotification

Gets a notification that has previously been posted by the current application. Note that the obtained notification's progressType is PERCENTAGE.

Notification getNotification(NotificationId id);

Since: 4.0

Remark: This method is designed to return new representation of a notification.

Parameters:

• id: A previously posted notification ID.

Return value:

Notification: Notification previously been posted by the current application.

Exceptions:

• WebAPIException

  • with error type NotFoundError, if NotificationId is not found in the previously posted notifications.

  • with error type AbortError, if any other error occurs.

Code example:

try
{
  /* Uses a variable for the previously posted notification. */
  /* Saves the notification ID for future use. */
  var myId = notification.id;

  var myNotification = tizen.notification.getNotification(myId);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

getAll

Gets all notifications that have previously been posted by the current application. Note that the obtained notification's progressType is PERCENTAGE

Deprecated. Deprecated since 4.0. Use getAllNotifications instead.

Notification[] getAll();

Since: 2.0

Remark: This method is designed to return old-style notifications.

Return value:

Notification[]: All notifications previously been posted by the current application.

Exceptions:

• WebAPIException

  • with error type UnknownError, if any other error occurs.

Code example:

try
{
  var notifications = tizen.notification.getAll();

  for (var index = 0; index < notifications.length; index++)
  {
    console.log(notifications[index].id);
    console.log(notifications[index].title);
    console.log(notifications[index].statusType);
    console.log(notifications[index].type);
    console.log(notifications[index].content);
    console.log(notifications[index].postedTime);
    console.log(notifications[index].iconPath);
    console.log(notifications[index].soundPath);
    console.log(notifications[index].vibration);
    console.log(notifications[index].appControl);
  }
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

getAllNotifications

Gets all notifications that have previously been posted by the current application. Note that the obtained notification's progressType is PERCENTAGE.

Notification[] getAllNotifications();

Since: 4.0

Remark: This method is designed to return new representation of a notifications.

Return value:

Notification[]: All notifications posted previously by the current application.

Exceptions:

• WebAPIException

  • with error type AbortError, if any error occurs.

Code example:

try
{
  var notifications = tizen.notification.getAllNotifications();

  for (var index = 0; index < notifications.length; index++)
  {
    console.log(notifications[index].id);
    console.log(notifications[index].type);
    console.log(notifications[index].userType);
    console.log(notifications[index].content);
    console.log(notifications[index].postedTime);
    console.log(notifications[index].images.iconPath);
    console.log(notifications[index].actions.soundPath);
    console.log(notifications[index].actions.vibration);
    console.log(notifications[index].actions.appControl);
  }
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

playLEDCustomEffect

Plays the custom effect of the service LED that is located to the front of a device.

void playLEDCustomEffect(long timeOn, long timeOff, DOMString color, LEDCustomFlags[] flags);

Since: 2.4

Given parameters consist of timeOn and timeOff in milliseconds, RGBA color and LEDCustomFlags combination. For the color first three bytes are RGB values. The last byte is opacity. For example "#FFFF0080". There is also another possibility when the last byte is not given (in this case alpha is assumed to have a value of 0xff). In this case only RGB values are given. For example: "#ff0000" that is equivalent of "#ff0000ff".

Privilege level: public

Privilege: http://tizen.org/privilege/led

Parameters:

• timeOn: Turn on time in milliseconds.
• timeOff: Turn off time in milliseconds.
• color: The RGBA color value. The first three bytes are RGB values. The last byte is opacity. Exemplary string "#FFFF0080".
• flags: The combination of enum LEDCustomFlags.

Exceptions:

• WebAPIException

  • with error type InvalidValuesError, if any of the input parameters contain an invalid value.

  • with error type SecurityError, if the application does not have the privilege to call this method or if the author signature does not match that of the designated application.

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter

  • with error type UnknownError, if the method cannot be completed because of an unknown error.

Code example:

try
{
  tizen.notification.playLEDCustomEffect(
      1000, 1000, "#FFFF0080", ["LED_CUSTOM_DUTY_ON", "LED_CUSTOM_DEFAULT"]);
}
catch (err)
{
  console.log("Error Exception, error name : " + err.name + ", error message : " + err.message);
}

stopLEDCustomEffect

Stops the custom effect of the service LED that is located to the front of a device.

void stopLEDCustomEffect();

Since: 2.4

Privilege level: public

Privilege: http://tizen.org/privilege/led

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type UnknownError, if the method cannot be completed because of an unknown error.

Code example:

try
{
  tizen.notification.playLEDCustomEffect(
      1000, 1000, "#FFFF0080", ["LED_CUSTOM_DUTY_ON", "LED_CUSTOM_DEFAULT"]);
  setTimeout(function()
  {
    tizen.notification.stopLEDCustomEffect();
  }, 5000);
}
catch (err)
{
  console.log("Error Exception, error name : " + err.name + ", error message : " + err.message);
}

saveNotificationAsTemplate

Saves a notification template to the notification database.

void saveNotificationAsTemplate(DOMString name, Notification notification);

Since: 4.0

An application can save the created notification as a template for later reuse. If the template has the same name as a saved one, the saved template will be overwritten.

A saved template can be loaded only by the application which saved it. All templates are removed when the application package is uninstalled.

Privilege level: public

Privilege: http://tizen.org/privilege/notification

Remark: The number of templates is limited to 10. When you try to add more than 10 templates, exception is thrown.

Parameters:

• name: The name of template to be saved.
• notification: A notification to be saved as a template.

Exceptions:

• WebAPIException

  • with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type QuotaExceededError, if the allowed number of templates is exceeded.

  • with error type AbortError, if the method cannot be completed because of any error.

Code example:

try
{
  var notificationGroupDict =
  {
    content: "This is a progress notification.",
    images: {iconPath: "images/image2.jpg"},
    actions: {soundPath: "music/Over the horizon.mp3", vibration: true}
  };

  /* Constructs the progress notification. */
  var notification =
      new tizen.UserNotification("PROGRESS", "Progress notification", notificationGroupDict);

  tizen.notification.saveNotificationAsTemplate("PROGRESS_TEMPLATE", notification);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}

createNotificationFromTemplate

Creates notification based on previously created template.

UserNotification createNotificationFromTemplate(DOMString name);

Since: 4.0

An application can load a saved template and post it. An application can load only templates that it has saved.

Privilege level: public

Privilege: http://tizen.org/privilege/notification

Remark: This method is designed to return only UserNotification objects, even if the template was saved as StatusNotification.

Parameters:

• name: The name of template to be used as source of notification.

Return value:

UserNotification: Created notification.

Exceptions:

• WebAPIException

  • with error type SecurityError, if the application does not have the privilege to call this method.

  • with error type NotFoundError, if the method cannot find a template with a given name.

  • with error type AbortError, if the method cannot be completed because of any error.

Code example:

/* The template with name "SIMPLE_TEMPLATE" should be previously created. */
try
{
  var notification = tizen.notification.createNotificationFromTemplate("SIMPLE_TEMPLATE");
  console.log("UserNotification - " + notification.title);
}
catch (err)
{
  console.log(err.name + ": " + err.message);
}