Enumeration for notification count position in the text.

Since :

2.3.1

Enumeration for notification errors.

Since :

2.3.1

Enumeration for application execution type.

Since :

2.3.1

Notification handle.

Since :

2.3.1

Enumeration for image type.

Since :

2.3.1

Enumeration for notification lauch option type.

Since :

2.3.1

Enumeration for notification LED operation.

Since :

2.3.1

Enumeration for notification layout type.

Since :

2.3.1

The structure for notification operation.

Since :

2.3.1

Enumeration for notification operation data code.

Since :

2.3.1

Enumeration for notification operation code.

Since :

2.3.1

Enumeration for notification sound type.

Since :

2.3.1

Enumeration for notification text type.

Since :

2.3.1

Enumeration for notification type.

Since :

2.3.1

Enumeration for notification variable parameter type.

Since :

2.3.1

Enumeration for notification vibration type.

Since :

2.3.1

Enumeration for notification count position in the text.

Since :

2.3.1

Enumerator:

NOTIFICATION_COUNT_POS_NONE	Count data is not displaying in the text
NOTIFICATION_COUNT_POS_LEFT	Count data is displaying at the left of the text
NOTIFICATION_COUNT_POS_IN	Count data is displaying in the text
NOTIFICATION_COUNT_POS_RIGHT	Count data is displaying at the right of the text
NOTIFICATION_COUNT_POS_MAX	Max flag

Enumeration for notification errors.

Since :

2.3.1

Enumerator:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter
NOTIFICATION_ERROR_OUT_OF_MEMORY	out of memory
NOTIFICATION_ERROR_IO_ERROR	I/O error
NOTIFICATION_ERROR_PERMISSION_DENIED	Permission denied
NOTIFICATION_ERROR_FROM_DB	Error from DB query
NOTIFICATION_ERROR_ALREADY_EXIST_ID	Already exist private ID
NOTIFICATION_ERROR_FROM_DBUS	Error from DBus
NOTIFICATION_ERROR_NOT_EXIST_ID	Not exist private ID
NOTIFICATION_ERROR_SERVICE_NOT_READY	No reponse from notification service

Enumeration for application execution type.

Since :

2.3.1

Enumerator:

NOTIFICATION_EXECUTE_TYPE_NONE	No operation
NOTIFICATION_EXECUTE_TYPE_RESPONDING	Responding action
NOTIFICATION_EXECUTE_TYPE_SINGLE_LAUNCH	Launching when notification data is single
NOTIFICATION_EXECUTE_TYPE_MULTI_LAUNCH	Launching when notification data is grouping(multi)
NOTIFICATION_EXECUTE_TYPE_MAX	Max flag

Enumeration for Group ID.

Since :

2.3.1

Enumerator:

NOTIFICATION_GROUP_ID_NONE	Not Grouping
NOTIFICATION_GROUP_ID_DEFAULT	Notification that has same title is grouping

Enumeration for image type.

Since :

2.3.1

Enumerator:

NOTIFICATION_IMAGE_TYPE_NONE	NONE
NOTIFICATION_IMAGE_TYPE_ICON	Icon
NOTIFICATION_IMAGE_TYPE_ICON_FOR_INDICATOR	Indicator icon
NOTIFICATION_IMAGE_TYPE_ICON_FOR_LOCK	Lock screen icon
NOTIFICATION_IMAGE_TYPE_THUMBNAIL	Thumbnail
NOTIFICATION_IMAGE_TYPE_THUMBNAIL_FOR_LOCK	Lock screen thumbnail
NOTIFICATION_IMAGE_TYPE_ICON_SUB	Icon
NOTIFICATION_IMAGE_TYPE_BACKGROUND	image displayed on background
NOTIFICATION_IMAGE_TYPE_LIST_1	Image for thumbnail list
NOTIFICATION_IMAGE_TYPE_LIST_2	Image for thumbnail list
NOTIFICATION_IMAGE_TYPE_LIST_3	Image for thumbnail list
NOTIFICATION_IMAGE_TYPE_LIST_4	Image for thumbnail list
NOTIFICATION_IMAGE_TYPE_LIST_5	Image for thumbnail list
NOTIFICATION_IMAGE_TYPE_MAX	Max flag

Enumeration for notification lauch option type.

Since :

2.3.1

Enumerator:

NOTIFICATION_LAUNCH_OPTION_APP_CONTROL

launching with app control

Enumeration for notification LED operation.

Since :

2.3.1

Enumerator:

NOTIFICATION_LED_OP_OFF	Default value. Disable the LED notification
NOTIFICATION_LED_OP_ON	Turn on the LED with default color
NOTIFICATION_LED_OP_ON_CUSTOM_COLOR	Turn on the LED with custom color
NOTIFICATION_LED_OP_MAX	Max flag

Enumeration for notification layout type.

Since :

2.3.1

Enumerator:

NOTIFICATION_LY_NONE	Default
NOTIFICATION_LY_NOTI_EVENT_SINGLE	Layout for notification. Used to inform single event
NOTIFICATION_LY_NOTI_EVENT_MULTIPLE	Layout for notification. Used to inform multiple event
NOTIFICATION_LY_NOTI_THUMBNAIL	Layout for notification. Used to display images
NOTIFICATION_LY_ONGOING_EVENT	Layout for ongoing notification. Used to display text message
NOTIFICATION_LY_ONGOING_PROGRESS	Layout for ongoing notification. Used to display progress
NOTIFICATION_LY_MAX	TBD

Enumeration for notification operation data code.

Since :

2.3.1

Enumerator:

NOTIFICATION_OP_DATA_MIN	Default
NOTIFICATION_OP_DATA_TYPE	Operation type
NOTIFICATION_OP_DATA_PRIV_ID	Private ID
NOTIFICATION_OP_DATA_NOTI	Notification handler
NOTIFICATION_OP_DATA_EXTRA_INFO_1	Reserved
NOTIFICATION_OP_DATA_EXTRA_INFO_2	Reserved
NOTIFICATION_OP_DATA_MAX	Max flag

Enumeration for notification operation code.

Since :

2.3.1

Enumerator:

NOTIFICATION_OP_NONE	Default
NOTIFICATION_OP_INSERT	Notification inserted
NOTIFICATION_OP_UPDATE	Notification updated
NOTIFICATION_OP_DELETE	Notification deleted
NOTIFICATION_OP_DELETE_ALL	Notifications deleted
NOTIFICATION_OP_SERVICE_READY	Notification service is ready

Enumeration for Private ID.

Since :

2.3.1

Enumerator:

NOTIFICATION_PRIV_ID_NONE

Internally set priv_id

Enumeration for notification property.

Since :

2.3.1

Enumerator:

NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE	Display only SIM card inserted
NOTIFICATION_PROP_DISABLE_APP_LAUNCH	Disable application launch when it selected
NOTIFICATION_PROP_DISABLE_AUTO_DELETE	Disable auto delete when it selected
NOTIFICATION_PROP_DISABLE_UPDATE_ON_INSERT	Disable update when it inserted.
NOTIFICATION_PROP_DISABLE_UPDATE_ON_DELETE	Disable update when it deleted.
NOTIFICATION_PROP_VOLATILE_DISPLAY	Deleted when device is rebooted eventhough NOTIFICATION_TYPE_NOTI type

Enumeration for notification sound type.

Since :

2.3.1

Enumerator:

NOTIFICATION_SOUND_TYPE_NONE	Default value. no sound
NOTIFICATION_SOUND_TYPE_DEFAULT	Default sound
NOTIFICATION_SOUND_TYPE_USER_DATA	User sound data
NOTIFICATION_SOUND_TYPE_MAX	Max flag

Enumeration for notification text type.

Since :

2.3.1

Enumerator:

NOTIFICATION_TEXT_TYPE_NONE	NONE
NOTIFICATION_TEXT_TYPE_TITLE	Title
NOTIFICATION_TEXT_TYPE_CONTENT	Content
NOTIFICATION_TEXT_TYPE_CONTENT_FOR_DISPLAY_OPTION_IS_OFF	Content for content display option is off of the Settings
NOTIFICATION_TEXT_TYPE_EVENT_COUNT	Text to display event count
NOTIFICATION_TEXT_TYPE_INFO_1	Box contents 1
NOTIFICATION_TEXT_TYPE_INFO_SUB_1	Box contents 1-1
NOTIFICATION_TEXT_TYPE_INFO_2	Box contents 2
NOTIFICATION_TEXT_TYPE_INFO_SUB_2	Box contents 2-1
NOTIFICATION_TEXT_TYPE_INFO_3	Box contents 3
NOTIFICATION_TEXT_TYPE_INFO_SUB_3	Box contents 3-1
NOTIFICATION_TEXT_TYPE_GROUP_TITLE	Group title
NOTIFICATION_TEXT_TYPE_GROUP_CONTENT	Group content
NOTIFICATION_TEXT_TYPE_GROUP_CONTENT_FOR_DISPLAY_OPTION_IS_OFF	Group content for content display option is off of the Settings
NOTIFICATION_TEXT_TYPE_MAX	Max flag

Enumeration for notification type.

Since :

2.3.1

Enumerator:

NOTIFICATION_TYPE_NONE	None
NOTIFICATION_TYPE_NOTI	Notification type
NOTIFICATION_TYPE_ONGOING	Ongoing type
NOTIFICATION_TYPE_MAX	Max flag

Enumeration for notification variable parameter type.

Since :

2.3.1

Enumerator:

NOTIFICATION_VARIABLE_TYPE_NONE	Variable parameter type is NONE
NOTIFICATION_VARIABLE_TYPE_INT	Variable parameter type is int
NOTIFICATION_VARIABLE_TYPE_DOUBLE	Variable parameter type is double
NOTIFICATION_VARIABLE_TYPE_STRING	Variable parameter type is string
NOTIFICATION_VARIABLE_TYPE_COUNT	Variable parameter type is count
NOTIFICATION_VARIABLE_TYPE_MAX	Max flag

Enumeration for notification vibration type.

Since :

2.3.1

Enumerator:

NOTIFICATION_VIBRATION_TYPE_NONE	Default value. No vibration
NOTIFICATION_VIBRATION_TYPE_DEFAULT	Default vibrate pattern
NOTIFICATION_VIBRATION_TYPE_USER_DATA	User vibration data
NOTIFICATION_VIBRATION_TYPE_MAX	Max flag

Enumeration for display application list.

Since :

2.3.1

Enumerator:

NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY	Notification Tray(Quickpanel)
NOTIFICATION_DISPLAY_APP_TICKER	Ticker notification
NOTIFICATION_DISPLAY_APP_LOCK	Lock screen
NOTIFICATION_DISPLAY_APP_INDICATOR	Indicator
NOTIFICATION_DISPLAY_APP_ALL	All display application

Creates a notification clone.

Newly created notification handle is returned.

Since :

2.3.1

Remarks:

This cloned notification handle should be freed using notification_free().

Parameters:

[in]	noti	The notification handle
[out]	clone	The newly created notification handle that has same with input noti

Returns:

NOTIFICATION_ERROR_NONE if success, otherwise any other value if failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

See also:

notification_type_e

Sample code:

#include <notification.h>
...
{
    notification_h noti = notification_create(NOTIFICATION_TYPE_NOTI);
    notification_h clone = NULL;

    notification_clone(noti, &clone);
    ...
}

Creates internal structure data and returns a notification handle.

Available type is NOTIFICATION_TYPE_NOTI and NOTIFICATION_TYPE_ONGOING. NOTIFICATION_TYPE_NOTI is remaining notification data even if device is restarted. NOTIFICATION_TYPE_ONGOING can display progressive feather, but notification data is removed after device is restarted.

Since :

2.3.1

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.

Parameters:

[in]

type

The notification type

Returns:

Notification handle(notification_h) on success, otherwise NULL on failure

Return values:

notification_h	Success
NULL	Failure

Exceptions:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value
NOTIFICATION_ERROR_OUT_OF_MEMORY	Out of memory

See also:

notification_type_e

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }
    ...
}

Deletes a notification with the given handle.

notification_delete() removes notification data from database and notification_free() releases memory of notification data.

Since :

2.3.1

Privilege Level:

public

Privilege:

http://tizen.org/privilege/notification

Parameters:

[in]

noti

The notification handle

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value
NOTIFICATION_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this method

Sample code:

#include <notification.h>
...
 {
    notificaton_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    ...

    noti_err  = notification_delete(noti);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }

}

Deletes all notifications of the given type.

Since :

2.3.1

Privilege Level:

public

Privilege:

http://tizen.org/privilege/notification

Parameters:

[in]

type

Notification type

Returns:

NOTIFICATION_ERROR_NONE if success, other value if failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value
NOTIFICATION_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this method

Sample code:

#include <notification.h>
...
 {
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti_err  = notification_delete_all(NOTIFICATION_TYPE_NOTI);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Frees the internal structure data of a notification handle.

Internal data of a notification handle is released. Data of the inserted notification is not deleted.

Since :

2.3.1

Parameters:

[in]

noti

The notification handle

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

Notification handle should be created by notification_create().

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }
    ...

    noti_err = notification_free(noti);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the application list displaying the notification from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	applist	The display application list

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    int applist = 0;

    noti_err  = notification_get_display_applist(noti, &applist);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the absolute path of an image file.

Since :

2.3.1

Remarks:

Do not free image_path. It will be freed when notification_free() is called.

Parameters:

[in]	noti	Notification handle
[in]	type	Notification image type
[out]	image_path	image file full path

Returns:

NOTIFICATION_ERROR_NONE on success, other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

Notification handle should be created by notification_create().

See also:

notification_image_type_e

notification_create()

Sample code:

 #include <notification.h>
 ...
 {
    char *image_path = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    
    noti_err  = notification_get_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, &image_path);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets an insertion timestamp of the notification.

If ret_time is 0, this notification data is not inserted before.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	ret_time	The return time value

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

 #include <notification.h>
  ...
  {
     time_t ret_time;
     int noti_err = NOTIFICATION_ERROR_NONE;
     
     noti_err  = notification_get_insert_time(noti, &ret_time);
     if(noti_err != NOTIFICATION_ERROR_NONE) {
         return;
     }
 }

Gets the launch option from the notification handle.

Since :

2.3.1

Remarks:

You must release app_control using app_control_destroy().

Parameters:

[in]	noti	The notification handle
[in]	type	Launching option type
[out]	option	The pointer of App Control handler

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    app_control_h app_control = NULL;
    app_control_create(&app_control);

    ...

    noti_err = notification_get_launch_option(noti, NOTIFICATION_LAUNCH_OPTION_APP_CONTROL, (void *)&app_control);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }
}

Gets the layout of the notification view from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	layout	The type of layout

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

See also:

notification_ly_type_e

Gets the LED displaying option from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	operation	The LED notification operation
[out]	led_argb	The notification LED color

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
 {
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    notification_led_type_e type = NOTIFICATION_LED_TYPE_NONE;

    noti_err  = notification_get_led(noti, &type, NULL);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the time period of flashing the LED from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	on_ms	The time for turning on the LED
[out]	off_ms	The time for turning on the LED

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
 {
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    int led_on_ms = 0;
    int led_off_ms = 0;

    noti_err  = notification_get_led_time_period(noti, &led_on_ms, &led_off_ms);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the progress from the notification handle.

Since :

2.3.1

Remarks:

At the end of the operation, the progress should be 1.0.

Parameters:

[in]	noti	The notification handle
[out]	percentage	The progress percentage

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    double percentage = 0.0;

    noti_err  = notification_get_progress(noti, &percentage);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the property of the notification from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	flags	The notification property

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    int flags = 0;

    noti_err  = notification_get_property(noti, &flags);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the progress size.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	size	The progress size

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    double size = 0.0;

    noti_err  = notification_get_size(noti, &size);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the sound type from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	type	The notification sound type
[out]	path	The user sound file path

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    notification_sound_type_e type = NOTIFICATION_SOUND_TYPE_NONE;

    noti_err  = notification_get_sound(noti, &type, NULL);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the tag of the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	Notification handle
[out]	tag	tag for loading notification handle

Returns:

NOTIFICATION_ERROR_NONE on success, other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter
NOTIFICATION_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this method

See also:

notification_set_tag()

Sample code:

#include <notification.h>
...
{
    int noti_err = NOTIFICATION_ERROR_NONE;
    const char *tag = NULL;

    ...

    noti_err = notification_get_tag(noti, &tag);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the text from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	The notification text type
[out]	text	The notification text

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    char *text = NULL;

    noti_err  = notification_get_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, &text);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets a timestamp.

If ret_time is 0, time information is not set before.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	ret_time	The return time value

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

Notification handle should be created by notification_create().

See also:

notification_create()

Sample code:

 #include <notification.h>
 ...
 {
    time_t ret_time;
    int noti_err = NOTIFICATION_ERROR_NONE;
    
    noti_err  = notification_get_time(noti, &ret_time);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the timestamp from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	The notification text type
[in]	time	The pointer of time stamp

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

Notification handle should be created by notification_create().

Gets the type of a notification.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	type	The notification type

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
 {
    int noti_err = NOTIFICATION_ERROR_NONE;
    notification_type_e type;

    noti_err  = notification_get_type(noti, &type);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Gets the vibrate type from the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[out]	type	The notification sound type
[out]	path	The user vibration file path

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
 {
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    notification_vibration_type_e type = NOTIFICATION_VIBRATION_TYPE_NONE;

    noti_err  = notification_get_vibration(noti, &type, NULL);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Loads a notification from the notification's database with the tag.

Since :

2.3.1

Privilege Level:

public

Privilege:

http://tizen.org/privilege/notification

Remarks:

The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.

Parameters:

[in]

tag

tag for loading notification handle

Returns:

Notification handle(notification_h) on success, NULL on failure

Return values:

notification_h	Success
NULL	Failure

Exceptions:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value
NOTIFICATION_ERROR_OUT_OF_MEMORY	Out of memory
NOTIFICATION_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this method

See also:

notification_type_e

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;

    noti = notification_load_by_tag(tag);
    if(noti == NULL) {
        return;
    }
    ...
}

Posts a notification.

Since :

2.3.1

Privilege Level:

public

Privilege:

http://tizen.org/privilege/notification

Parameters:

[in]

noti

Notification handle

Returns:

NOTIFICATION_ERROR_NONE if success, other value if failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter
NOTIFICATION_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this method

Precondition:

Notification handle should be created by notification_create().

Postcondition:

notification_free().

Sample code:

#include <notification.h>
...
 {
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti_err  = notification_post(noti);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Sets applications to display the notification.

All display application is enable(NOTIFICATION_DISPLAY_APP_ALL) if you are not call this API.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	applist	The with | operation

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    bundle *b = NULL;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }

    noti_err  = notification_set_display_applist(noti, NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY | NOTIFICATION_DISPLAY_APP_TICKER);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }
}
}

Sets an absolute path for an image file to display on the notification view.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	The notification image type
[in]	image_path	The image file full path

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

Notification handle should be created by notification_create().

See also:

notification_image_type_e

notification_create()

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }

    noti_err  = notification_set_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, APP_IMAGE_FULL_PATH);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }
}

Sets the launch option for a notification.

When notification data selected in display application, application launched by app_control_send_launch_request with app_control handle.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	Launching option type
[in]	option	App Control handler

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    app_control_h app_control = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    ...

    app_control_create(&app_control);
    app_control_set_app_id(app_control, "org.tizen.app");

    ...

    noti_err  = notification_set_launch_option(noti, NOTIFICATION_LAUNCH_OPTION_APP_CONTROL, (void *)app_control);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }

    app_control_destroy(app_control);
}

Sets the layout of the notification view.

Caller can set displaying layout of notification.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	layout	The type of layout

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

See also:

notification_ly_type_e

Sets the LED displaying option.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	operation	The LED notification operation
[in]	led_argb	The notification led color

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti_err  = notification_set_led(noti, NOTIFICATION_LED_TYPE_DEFAULT, NULL);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Sets the time period of flashing the LED.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	on_ms	The time for turning on the LED
[in]	off_ms	The time for turning off the LED

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti_err  = notification_set_led_time_period(noti, 100, 100);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Sets the initial progress for the ongoing type.

After the notification_post() call, the progress is not updated.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	percentage	The progress percentage

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }

    noti_err  = notification_set_progress(noti, 0.0);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }
}

Sets the property of the notification.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	flags	The property with | operation

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;
    bundle *b = NULL;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }

    noti_err  = notification_set_property(noti, NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE | NOTIFICATION_PROP_DISABLE_APP_LAUNCH);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }
}

Sets the initial size for the ongoing type.

After notification_post() call, the size is not updated.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	size	The double type size

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }

    noti_err  = notification_set_size(noti, 0.0);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }
}

Sets the sound type for the notification.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	The notification sound type
[in]	path	The user sound file path

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti_err  = notification_set_sound(noti, NOTIFICATION_SOUND_TYPE_DEFAULT, NULL);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Sets the tag of the notification handle.

Since :

2.3.1

Parameters:

[in]	noti	Notification handle
[in]	tag	tag for loading notification handle

Returns:

NOTIFICATION_ERROR_NONE on success, other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter
NOTIFICATION_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this method

See also:

notification_get_tag()

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }
    ...

    noti_err = notification_set_tag(noti, tag);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Sets the text to display on the notification view.

Sets title, content string. If the text is formatted data (only d, f, s are supported), type - value pair should be set. If d, the type NOTIFICATION_VARIABLE_TYPE_INT and the value is an integer. If f, the type NOTIFICATION_VARIABLE_TYPE_DOUBLE and the value is a double. If s, the type NOTIFICATION_VARIABLE_TYPE_STRING and the value is a string. If the type is NOTIFICATION_VARIABLE_TYPE_COUNT, notification count is displaying with text. If the value is NOTIFICATION_COUNT_POS_LEFT, count is displayed at the left of the text. If the value is NOTIFICATION_COUNT_POS_IN, count is displayed in the text when text has d format. If the value is NOTIFICATION_COUNT_POS_RIGHT, count is displayed at the right of the text. Variable parameters should be terminated NOTIFICATION_VARIABLE_TYPE_NONE.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	The notification text type
[in]	text	The basic text
[in]	key	The text key for localization
[in]	args_type	The variable parameter that type - value pair

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

notification handle should be created by notification_create().

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti = notification_create(NOTIFICATION_TYPE_NOTI);
    if(noti == NULL) {
        return;
    }

    noti_err  = notification_set_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, "I'm Title", "IDS_APP_BODY_IM_TITLE", NOTIFICATION_VARIABLE_TYPE_NONE);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
        return;
    }
}

Sets a timestamp.

If input_time is 0, time information is taken from the current time.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	input_time	The input time

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

Notification handle should be created by notification_create().

See also:

notification_create()

Sample code:

#include <notification.h>
 ...
  {
     notification_h noti = NULL;
     int noti_err = NOTIFICATION_ERROR_NONE;
     
     noti = notification_create(NOTIFICATION_TYPE_NOTI);
     if(noti == NULL) {
         return;
     }
 
     noti_err  = notification_set_time(noti, time(NULL));
     if(noti_err != NOTIFICATION_ERROR_NONE) {
        notification_free(noti);
         return;
     }
 }

Sets the timestamp to display on the notification view.

The timestamp will be converted to a formatted string and it will be displayed on the set text area.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	The notification text type
[in]	time	The timestamp

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Precondition:

Notification handle should be created by notification_create().

Sets the vibration type for the notification.

Since :

2.3.1

Parameters:

[in]	noti	The notification handle
[in]	type	The notification vibration type
[in]	path	The user vibration file path

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid parameter

Sample code:

#include <notification.h>
...
{
    notification_h noti = NULL;
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti_err  = notification_set_vibration(noti, NOTIFICATION_VIBRATION_TYPE_DEFAULT, NULL);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}

Updates notification data.

The updated notification will appear in the notification area.

Since :

2.3.1

Privilege Level:

public

Privilege:

http://tizen.org/privilege/notification

Parameters:

[in]

noti

The notification handle that is created by notification_create()

Returns:

NOTIFICATION_ERROR_NONE on success, otherwise any other value on failure

Return values:

NOTIFICATION_ERROR_NONE	Success
NOTIFICATION_ERROR_INVALID_PARAMETER	Invalid input value
NOTIFICATION_ERROR_NOT_EXIST_ID	Priv ID does not exist
NOTIFICATION_ERROR_PERMISSION_DENIED	The application does not have the privilege to call this method

Sample code:

#include <notification.h>
...
 {
    int noti_err = NOTIFICATION_ERROR_NONE;

    noti_err  = notification_update(NULL);
    if(noti_err != NOTIFICATION_ERROR_NONE) {
        return;
    }
}