Tizen Native API  5.5

Notification EX APIs.

Required Header

#include <notification_ex.h>

Overview

A notification ex API is a set of expanded APIs for notifications. The expanded notification is the predefined type of notifications. The notification can define actions with one item or group of items. It supports displaying the notification with selectors to select predefined input and controlling visibility of the created notification items.

Functions

int noti_ex_action_app_control_create (noti_ex_action_h *handle, app_control_h app_control, const char *extra)
 Creates the notification_ex action handle with app control handle.
int noti_ex_action_app_control_set (noti_ex_action_h handle, app_control_h app_control)
 Sets the app control handle for notification_ex action.
int noti_ex_action_app_control_get (noti_ex_action_h handle, app_control_h *app_control)
 Gets the app control handle from notification_ex action.
int noti_ex_item_button_create (noti_ex_item_h *handle, const char *id, const char *title)
 Creates the notification_ex item handle with a button.
int noti_ex_item_button_get_title (noti_ex_item_h handle, char **title)
 Gets the title of a button item.
int noti_ex_item_button_set_multi_language_title (noti_ex_item_h handle, noti_ex_multi_lang_h multi)
 Sets the multi-language handle.
int noti_ex_item_chat_message_create (noti_ex_item_h *handle, const char *id, noti_ex_item_h name, noti_ex_item_h text, noti_ex_item_h image, noti_ex_item_h time, noti_ex_item_chat_message_type_e message_type)
 Creates the notification_ex item handle for the chat message.
int noti_ex_item_chat_message_get_name (noti_ex_item_h handle, noti_ex_item_h *name)
 Gets the notification_ex item handle for the chat message name.
int noti_ex_item_chat_message_get_text (noti_ex_item_h handle, noti_ex_item_h *text)
 Gets the notification_ex item handle for the chat message text.
int noti_ex_item_chat_message_get_image (noti_ex_item_h handle, noti_ex_item_h *image)
 Gets the notification_ex item handle for the chat message image.
int noti_ex_item_chat_message_get_time (noti_ex_item_h handle, noti_ex_item_h *time)
 Gets the notification_ex item handle for the chat message time.
int noti_ex_item_chat_message_get_message_type (noti_ex_item_h handle, noti_ex_item_chat_message_type_e *message_type)
 Gets the type of chat message.
int noti_ex_item_checkbox_create (noti_ex_item_h *handle, const char *id, const char *title, bool checked)
 Creates the notification_ex item handle with checkbox.
int noti_ex_item_checkbox_get_title (noti_ex_item_h handle, char **title)
 Gets the title of a checkbox.
int noti_ex_item_checkbox_set_multi_language_title (noti_ex_item_h handle, noti_ex_multi_lang_h multi)
 Sets the multi-language handle.
int noti_ex_item_checkbox_get_check_state (noti_ex_item_h handle, bool *checked)
 Gets the check state of a checkbox.
int noti_ex_item_checkbox_set_check_state (noti_ex_item_h handle, bool checked)
 Sets the check state of a checkbox.
int noti_ex_item_entry_create (noti_ex_item_h *handle, const char *id)
 Creates the notification_ex item handle for an entry item.
int noti_ex_item_entry_get_text (noti_ex_item_h handle, char **text)
 Gets the text of an entry item.
int noti_ex_item_entry_set_text (noti_ex_item_h handle, const char *text)
 Sets the text of an entry item.
int noti_ex_item_entry_set_multi_language (noti_ex_item_h handle, noti_ex_multi_lang_h multi)
 Sets the multi-language handle.
int noti_ex_event_info_clone (noti_ex_event_info_h handle, noti_ex_event_info_h *cloned_handle)
 Clones the notification event info handle.
int noti_ex_event_info_destroy (noti_ex_event_info_h handle)
 Releases the notification event info handle.
int noti_ex_event_info_get_event_type (noti_ex_event_info_h handle, noti_ex_event_info_type_e *event_type)
 Gets the type of an event.
int noti_ex_event_info_get_owner (noti_ex_event_info_h handle, char **owner)
 Gets the app id of event owner.
int noti_ex_event_info_get_channel (noti_ex_event_info_h handle, char **channel)
 Gets the channel of an event.
int noti_ex_event_info_get_item_id (noti_ex_event_info_h handle, char **item_id)
 Gets the id of a notification_ex item.
int noti_ex_event_info_get_request_id (noti_ex_event_info_h handle, int *req_id)
 Gets the id of request for an event.
int noti_ex_item_group_create (noti_ex_item_h *handle, const char *id)
 Creates the group of notification_ex items.
int noti_ex_item_group_set_direction (noti_ex_item_h handle, bool vertical)
 Sets the direction of children in the group item.
int noti_ex_item_group_is_vertical (noti_ex_item_h handle, bool *vertical)
 Gets the vertical state of group item.
int noti_ex_item_group_get_app_label (noti_ex_item_h handle, char **label)
 Gets the label of application.
int noti_ex_item_group_add_child (noti_ex_item_h handle, noti_ex_item_h child)
 Adds the child to the group item.
int noti_ex_item_group_remove_child (noti_ex_item_h handle, const char *item_id)
 Removes the child from the group item by notification_ex item id.
int noti_ex_item_group_foreach_child (noti_ex_item_h handle, noti_ex_item_group_foreach_child_cb callback, void *user_data)
 Gets the data of children from the group item.
int noti_ex_item_image_create (noti_ex_item_h *handle, const char *id, const char *image_path)
 Creates the notification_ex item handle with an image.
int noti_ex_item_image_get_image_path (noti_ex_item_h handle, char **image_path)
 Gets the path of image.
int noti_ex_item_input_selector_create (noti_ex_item_h *handle, const char *id)
 Creates the notification_ex item handle with input selector.
int noti_ex_item_input_selector_get_contents (noti_ex_item_h handle, char ***list, int *count)
 Gets the contents that can be selected by input selector.
int noti_ex_item_input_selector_set_contents (noti_ex_item_h handle, const char **contents, int count)
 Sets the contents for input selector item.
int noti_ex_item_input_selector_set_multi_language_contents (noti_ex_item_h handle, noti_ex_multi_lang_h *multi_language_list, int count)
 Sets the multi-language contents for input selector item.
int noti_ex_color_create (noti_ex_color_h *handle, unsigned char a, unsigned char r, unsigned char g, unsigned char b)
 Creates the notification_ex color handle.
int noti_ex_color_destroy (noti_ex_color_h handle)
 Releases a notification_ex color handle.
int noti_ex_color_get_alpha (noti_ex_color_h handle, unsigned char *val)
 Gets the alpha value of a color.
int noti_ex_color_get_red (noti_ex_color_h handle, unsigned char *val)
 Gets the red value of a color.
int noti_ex_color_get_green (noti_ex_color_h handle, unsigned char *val)
 Gets the green value of a color.
int noti_ex_color_get_blue (noti_ex_color_h handle, unsigned char *val)
 Gets the blue value of a color.
int noti_ex_padding_create (noti_ex_padding_h *handle, int left, int top, int right, int bottom)
 Creates the notification_ex padding handle.
int noti_ex_padding_destroy (noti_ex_padding_h handle)
 Releases a notification_ex padding handle.
int noti_ex_padding_get_left (noti_ex_padding_h handle, int *val)
 Gets the left value of padding.
int noti_ex_padding_get_top (noti_ex_padding_h handle, int *val)
 Gets the top value of padding.
int noti_ex_padding_get_right (noti_ex_padding_h handle, int *val)
 Gets the right value of padding.
int noti_ex_padding_get_bottom (noti_ex_padding_h handle, int *val)
 Gets the bottom value of padding.
int noti_ex_geometry_create (noti_ex_geometry_h *handle, int x, int y, int w, int h)
 Creates the notification_ex geometry handle.
int noti_ex_geometry_destroy (noti_ex_geometry_h handle)
 Releases the notification_ex geometry handle.
int noti_ex_geometry_get_x (noti_ex_geometry_h handle, int *val)
 Gets the x position value.
int noti_ex_geometry_get_y (noti_ex_geometry_h handle, int *val)
 Gets the y position value.
int noti_ex_geometry_get_width (noti_ex_geometry_h handle, int *val)
 Gets the width value.
int noti_ex_geometry_get_height (noti_ex_geometry_h handle, int *val)
 Gets the height value.
int noti_ex_style_create (noti_ex_style_h *handle, noti_ex_color_h color, noti_ex_padding_h padding, noti_ex_geometry_h geometry)
 Creates the notification_ex style handle.
int noti_ex_style_destroy (noti_ex_style_h handle)
 Releases the notification_ex style handle.
int noti_ex_style_get_padding (noti_ex_style_h handle, noti_ex_padding_h *padding)
 Gets the padding information from a style.
int noti_ex_style_get_color (noti_ex_style_h handle, noti_ex_color_h *color)
 Gets the color information from a style.
int noti_ex_style_get_geometry (noti_ex_style_h handle, noti_ex_geometry_h *geometry)
 Gets the geometry information from style.
int noti_ex_style_get_background_image (noti_ex_style_h handle, char **image_path)
 Gets the background image path from style.
int noti_ex_style_set_background_image (noti_ex_style_h handle, char *image_path)
 Sets the background image path of a style.
int noti_ex_style_get_background_color (noti_ex_style_h handle, noti_ex_color_h *color)
 Gets the background color of a style.
int noti_ex_style_set_background_color (noti_ex_style_h handle, noti_ex_color_h color)
 Sets the background color of a style.
int noti_ex_led_info_create (noti_ex_led_info_h *handle, noti_ex_color_h color)
 Creates the notification_ex LED info handle.
int noti_ex_led_info_destroy (noti_ex_led_info_h handle)
 Releases the notification_ex LED info handle.
int noti_ex_led_info_set_on_period (noti_ex_led_info_h handle, int ms)
 Sets the time period for turning on the LED.
int noti_ex_led_info_get_on_period (noti_ex_led_info_h handle, int *ms)
 Gets the time period for turning on the LED.
int noti_ex_led_info_set_off_period (noti_ex_led_info_h handle, int ms)
 Sets the time period for turning off the LED.
int noti_ex_led_info_get_off_period (noti_ex_led_info_h handle, int *ms)
 Gets the time period for turning off the LED.
int noti_ex_led_info_get_color (noti_ex_led_info_h handle, noti_ex_color_h *color)
 Gets the color information from LED info.
int noti_ex_action_destroy (noti_ex_action_h handle)
 Releases the notification_ex action handle.
int noti_ex_action_get_type (noti_ex_action_h handle, int *type)
 Gets the type of an action.
int noti_ex_action_is_local (noti_ex_action_h handle, bool *local)
 Gets the local state of an action.
int noti_ex_action_execute (noti_ex_action_h handle, noti_ex_item_h item)
 Executes the action for a notification_ex item.
int noti_ex_action_get_extra (noti_ex_action_h handle, char **extra)
 Gets the extra data for an action.
int noti_ex_item_info_get_hide_time (noti_ex_item_info_h handle, int *hide_time)
 Gets the time to hide the notification_ex item.
int noti_ex_item_info_set_hide_time (noti_ex_item_info_h handle, int hide_time)
 Sets the time to hide the notification_ex item.
int noti_ex_item_info_get_delete_time (noti_ex_item_info_h handle, int *delete_time)
 Gets the time to delete the notification_ex item.
int noti_ex_item_info_set_delete_time (noti_ex_item_info_h handle, int delete_time)
 Sets the time to delete the notification_ex item.
int noti_ex_item_info_get_time (noti_ex_item_info_h handle, time_t *time)
 Gets the time information.
int noti_ex_item_destroy (noti_ex_item_h handle)
 Releases the notification_ex item handle.
int noti_ex_item_find_by_id (noti_ex_item_h handle, const char *id, noti_ex_item_h *item)
 Finds the notification_ex item handle by notification_ex item id.
int noti_ex_item_get_type (noti_ex_item_h handle, int *type)
 Gets the type of notification_ex item.
int noti_ex_item_get_id (noti_ex_item_h handle, char **id)
 Gets the id of a notification_ex item.
int noti_ex_item_set_id (noti_ex_item_h handle, const char *id)
 Sets the id of a notification_ex item.
int noti_ex_item_get_action (noti_ex_item_h handle, noti_ex_action_h *action)
 Gets the action for a notification_ex item.
int noti_ex_item_set_action (noti_ex_item_h handle, noti_ex_action_h action)
 Sets the action of a notification_ex item.
int noti_ex_item_get_style (noti_ex_item_h handle, noti_ex_style_h *style)
 Gets the style of a notification_ex item.
int noti_ex_item_set_style (noti_ex_item_h handle, noti_ex_style_h style)
 Sets the style of a notification_ex item.
int noti_ex_item_set_visible (noti_ex_item_h handle, bool visible)
 Sets the visibility state of a notification_ex item.
int noti_ex_item_get_visible (noti_ex_item_h handle, bool *visible)
 Gets the visibility state of a notification_ex item.
int noti_ex_item_set_enable (noti_ex_item_h handle, bool enable)
 Sets the enabled state of a notification_ex item.
int noti_ex_item_get_enable (noti_ex_item_h handle, bool *enable)
 Gets the enabled state of a notification_ex item.
int noti_ex_item_add_receiver (noti_ex_item_h handle, const char *receiver_group)
 Adds the receiver group of a notification_ex item.
int noti_ex_item_remove_receiver (noti_ex_item_h handle, const char *receiver_group)
 Removes the receiver group from a notification_ex item.
int noti_ex_item_get_receiver_list (noti_ex_item_h handle, char ***list, int *count)
 Gets the list of receiver group of a notification_ex item.
int noti_ex_item_set_policy (noti_ex_item_h handle, int policy)
 Sets the policy of a notification_ex item.
int noti_ex_item_get_policy (noti_ex_item_h handle, int *policy)
 Gets the policy of a notification_ex item.
int noti_ex_item_get_channel (noti_ex_item_h handle, char **channel)
 Gets the channel of a notification_ex item.
int noti_ex_item_set_channel (noti_ex_item_h handle, const char *channel)
 Sets the channel of a notification_ex item.
int noti_ex_item_set_led_info (noti_ex_item_h handle, noti_ex_led_info_h led)
 Sets the LED information of a notification_ex item.
int noti_ex_item_get_led_info (noti_ex_item_h handle, noti_ex_led_info_h *led)
 Gets the LED information of a notification_ex item.
int noti_ex_item_set_sound_path (noti_ex_item_h handle, const char *path)
 Sets the sound path of a notification_ex item.
int noti_ex_item_get_sound_path (noti_ex_item_h handle, char **path)
 Gets the sound path of a notification_ex item.
int noti_ex_item_set_vibration_path (noti_ex_item_h handle, const char *path)
 Sets the vibration path of a notification_ex item.
int noti_ex_item_get_vibration_path (noti_ex_item_h handle, char **path)
 Gets the vibration path of a notification_ex item.
int noti_ex_item_get_info (noti_ex_item_h handle, noti_ex_item_info_h *info)
 Gets the information of a notification_ex item.
int noti_ex_item_get_sender_app_id (noti_ex_item_h handle, char **id)
 Gets the sender app id of a notification_ex item.
int noti_ex_item_get_tag (noti_ex_item_h handle, char **tag)
 Gets the tag of a notification_ex item.
int noti_ex_item_set_tag (noti_ex_item_h handle, const char *tag)
 Sets the tag of a notification_ex item.
int noti_ex_item_get_ongoing_state (noti_ex_item_h handle, bool *ongoing)
 Gets the value indicating whether a notification is currently ongoing.
int noti_ex_item_set_ongoing_state (noti_ex_item_h handle, bool ongoing)
 Sets the value indicating whether a notification is currently ongoing.
int noti_ex_item_check_type_exist (noti_ex_item_h handle, int type, bool *exist)
 Checks if an item of a specified type is included in a notification_ex item.
int noti_ex_item_get_main_type (noti_ex_item_h handle, int *type)
 Gets the main type of a notification item.
int noti_ex_item_set_main_type (noti_ex_item_h handle, const char *id, int type)
 Sets the main type of a notification item.
int noti_ex_item_find_by_main_type (noti_ex_item_h handle, int type, noti_ex_item_h *item)
 Finds the notification item of the specified main type.
int noti_ex_item_get_extension_data (noti_ex_item_h handle, const char *key, bundle **value)
 Gets the extension data.
int noti_ex_item_set_extension_data (noti_ex_item_h handle, const char *key, bundle *value)
 Sets the extension data.
int noti_ex_manager_create (noti_ex_manager_h *handle, const char *receiver_group, noti_ex_manager_events_s event_callbacks, void *user_data)
 Creates the notification_ex manager handle.
int noti_ex_manager_destroy (noti_ex_manager_h handle)
 Destroys the notification_ex manager handle.
int noti_ex_manager_get (noti_ex_manager_h handle, noti_ex_item_h **items, int *count)
 Gets all notifications for the notification_ex manager.
int noti_ex_manager_get_by_channel (noti_ex_manager_h handle, char *channel, noti_ex_item_h **items, int *count)
 Gets notifications with channel for the notification_ex manager.
int noti_ex_manager_update (noti_ex_manager_h handle, noti_ex_item_h item, int *request_id)
 Updates notification.
int noti_ex_manager_delete (noti_ex_manager_h handle, noti_ex_item_h noti, int *request_id)
 Deletes notification.
int noti_ex_manager_delete_all (noti_ex_manager_h handle, int *request_id)
 Deletes all notification.
int noti_ex_manager_hide (noti_ex_manager_h handle, noti_ex_item_h item, int *request_id)
 Hides notification.
int noti_ex_manager_find_by_root_id (noti_ex_manager_h handle, const char *root_id, noti_ex_item_h *item)
 Finds notification by root id.
int noti_ex_manager_send_error (noti_ex_manager_h handle, noti_ex_event_info_h info, noti_ex_error_e error)
 Sends error to the reporter.
int noti_ex_manager_get_notification_count (noti_ex_manager_h handle, int *count)
 Gets the count of notifications for the manager.
int noti_ex_multi_lang_create (noti_ex_multi_lang_h *handle, const char *msgid, const char *format,...)
 Creates the multi-language item handle.
int noti_ex_multi_lang_destroy (noti_ex_multi_lang_h handle)
 Destroys the multi-language item handle.
int noti_ex_item_progress_create (noti_ex_item_h *handle, const char *id, float min, float current, float max)
 Creates the notification_ex item handle with progress.
int noti_ex_item_progress_get_current (noti_ex_item_h handle, float *current)
 Gets the current value of progress.
int noti_ex_item_progress_set_current (noti_ex_item_h handle, float current)
 Sets the current value of progress.
int noti_ex_item_progress_get_min (noti_ex_item_h handle, float *min)
 Gets the minimum value of progress.
int noti_ex_item_progress_get_max (noti_ex_item_h handle, float *max)
 Gets the maximum value of progress.
int noti_ex_item_progress_get_type (noti_ex_item_h handle, int *type)
 Gets the type of progress. The type is equal to one of the values of noti_ex_item_progress_type_e.
int noti_ex_item_progress_set_type (noti_ex_item_h handle, int type)
 Sets the type of progress.
int noti_ex_reporter_create (noti_ex_reporter_h *handle, noti_ex_reporter_events_s event_callbacks, void *user_data)
 Creates the notification_ex reporter handle.
int noti_ex_reporter_destroy (noti_ex_reporter_h handle)
 Destroys the notification_ex reporter handle.
int noti_ex_reporter_send_error (noti_ex_reporter_h handle, noti_ex_event_info_h info, noti_ex_error_e error)
 Sends error to the manager.
int noti_ex_reporter_post (noti_ex_reporter_h handle, noti_ex_item_h noti, int *request_id)
 Posts a notification.
int noti_ex_reporter_post_list (noti_ex_reporter_h handle, noti_ex_item_h *noti_list, int count, int *request_id)
 Posts notifications contained in a list.
int noti_ex_reporter_update (noti_ex_reporter_h handle, noti_ex_item_h noti, int *request_id)
 Updates a notification.
int noti_ex_reporter_delete (noti_ex_reporter_h handle, noti_ex_item_h noti, int *request_id)
 Deletes a notification.
int noti_ex_reporter_delete_all (noti_ex_reporter_h handle, int *request_id)
 Deletes all notifications.
int noti_ex_reporter_find_by_root_id (noti_ex_reporter_h handle, const char *root_id, noti_ex_item_h *item)
 Finds notification by root id.
int noti_ex_item_text_create (noti_ex_item_h *handle, const char *id, const char *text, const char *hyperlink)
 Creates the notification_ex item handle with text.
int noti_ex_item_text_set_contents (noti_ex_item_h handle, const char *contents)
 Sets the text contents of the text item.
int noti_ex_item_text_get_contents (noti_ex_item_h handle, char **contents)
 Gets the text contents of the text item.
int noti_ex_item_text_get_hyperlink (noti_ex_item_h handle, char **hyperlink)
 Gets the hyperlink of the text item.
int noti_ex_item_text_set_multi_language (noti_ex_item_h handle, noti_ex_multi_lang_h multi)
 Sets the multi-language handle.
int noti_ex_item_time_create (noti_ex_item_h *handle, const char *id, time_t time)
 Creates the notification_ex item handle with time.
int noti_ex_item_time_get_time (noti_ex_item_h handle, time_t *time)
 Gets the time information of time item.
int noti_ex_action_visibility_create (noti_ex_action_h *handle, const char *extra)
 Creates the notification_ex action handle to control visibility.
int noti_ex_action_visibility_set (noti_ex_action_h handle, const char *id, bool visible)
 Sets the visibility state for notification_ex item.

Typedefs

typedef enum
_noti_ex_item_chat_message_type 
noti_ex_item_chat_message_type_e
 Enumeration for notification_ex chat message type.
typedef enum _noti_ex_error noti_ex_error_e
 Enumeration for notification errors.
typedef enum
_noti_ex_event_info_type 
noti_ex_event_info_type_e
 Enumeration for the type of notification event.
typedef void * noti_ex_event_info_h
 The handle for the notification event information.
typedef int(* noti_ex_item_group_foreach_child_cb )(noti_ex_item_h handle, void *user_data)
 Called to get the data of child item for each child of the group item.
typedef enum _noti_ex_item_type noti_ex_item_type_e
 Enumeration for notification_ex item types.
typedef enum _noti_ex_action_type noti_ex_action_type_e
 Enumeration for notification_ex action type.
typedef enum _noti_ex_item_policy noti_ex_item_policy_e
 Enumeration for notification_ex item policy.
typedef enum
_noti_ex_item_main_type 
noti_ex_item_main_type_e
 Enumeration for main types of notification_ex item.
typedef void * noti_ex_color_h
 The handle for the color information.
typedef void * noti_ex_padding_h
 The handle for the padding information.
typedef void * noti_ex_geometry_h
 The handle for the geometry information.
typedef void * noti_ex_style_h
 The handle for the style information.
typedef void * noti_ex_led_info_h
 The handle for the LED information.
typedef void * noti_ex_action_h
 The notification_ex action handle.
typedef void * noti_ex_item_h
 The notification_ex item handle.
typedef void * noti_ex_item_info_h
 The notification_ex item_info handle.
typedef void * noti_ex_manager_h
 The notification_ex manager handle.
typedef void(* noti_ex_manager_events_add_cb )(noti_ex_manager_h handle, noti_ex_event_info_h info, noti_ex_item_h *added_items, int count, void *user_data)
 Called when a notification addition event is received.
typedef void(* noti_ex_manager_events_update_cb )(noti_ex_manager_h handle, noti_ex_event_info_h info, noti_ex_item_h updated_item, void *user_data)
 Called when a notification update event is received.
typedef void(* noti_ex_manager_events_delete_cb )(noti_ex_manager_h handle, noti_ex_event_info_h info, noti_ex_item_h deleted_item, void *user_data)
 Called when a notification deletion event is received.
typedef void(* noti_ex_manager_events_error_cb )(noti_ex_manager_h handle, noti_ex_error_e error, int request_id, void *user_data)
 Called when an error event is received.
typedef void * noti_ex_multi_lang_h
 The notification_ex multi-language item handle.
typedef enum
_noti_ex_item_progress_type 
noti_ex_item_progress_type_e
 Enumeration for notification_ex progress item types.
typedef void * noti_ex_reporter_h
 The notification_ex reporter handle.
typedef void(* noti_ex_reporter_events_error_cb )(noti_ex_reporter_h handle, noti_ex_error_e error, int request_id, void *user_data)
 Called when the error event is received.
typedef void(* noti_ex_reporter_events_event_cb )(noti_ex_reporter_h handle, noti_ex_event_info_h info, noti_ex_item_h *items, int count, void *user_data)
 Called when the notification event is received.

Defines

#define NOTI_EX_RECEIVER_GROUP_PANEL   "tizen.org/receiver/panel"
 Predefined receiver group for the Panel.
#define NOTI_EX_RECEIVER_GROUP_TICKER   "tizen.org/receiver/ticker"
 Predefined receiver group for the Ticker.
#define NOTI_EX_RECEIVER_GROUP_LOCKSCREEN   "tizen.org/receiver/lockscreen"
 Predefined receiver group for the Lockscreen.
#define NOTI_EX_RECEIVER_GROUP_INDICATOR   "tizen.org/receiver/indicator"
 Predefined receiver group for the Indicator.
#define NOTI_EX_RECEIVER_GROUP_POPUP   "tizen.org/receiver/popup"
 Predefined receiver group for the Popup.
#define NOTI_EX_SOUND_TYPE_DEFAULT   "__SOUND_TYPE_DEFAULT__"
 Default sound.
#define NOTI_EX_VIBRATION_TYPE_DEFAULT   "__VIBRATION_TYPE_DEFAULT__"
 Default vibration.

Define Documentation

#define NOTI_EX_RECEIVER_GROUP_INDICATOR   "tizen.org/receiver/indicator"

Predefined receiver group for the Indicator.

Since :
5.5
#define NOTI_EX_RECEIVER_GROUP_LOCKSCREEN   "tizen.org/receiver/lockscreen"

Predefined receiver group for the Lockscreen.

Since :
5.5
#define NOTI_EX_RECEIVER_GROUP_PANEL   "tizen.org/receiver/panel"

Predefined receiver group for the Panel.

Since :
5.5
#define NOTI_EX_RECEIVER_GROUP_POPUP   "tizen.org/receiver/popup"

Predefined receiver group for the Popup.

Since :
5.5
#define NOTI_EX_RECEIVER_GROUP_TICKER   "tizen.org/receiver/ticker"

Predefined receiver group for the Ticker.

Since :
5.5
#define NOTI_EX_SOUND_TYPE_DEFAULT   "__SOUND_TYPE_DEFAULT__"

Default sound.

Since :
5.5
#define NOTI_EX_VIBRATION_TYPE_DEFAULT   "__VIBRATION_TYPE_DEFAULT__"

Default vibration.

Since :
5.5

Typedef Documentation

typedef void* noti_ex_action_h

The notification_ex action handle.

Since :
5.5

Enumeration for notification_ex action type.

Since :
5.5
typedef void* noti_ex_color_h

The handle for the color information.

Since :
5.5

Enumeration for notification errors.

Since :
5.5
typedef void* noti_ex_event_info_h

The handle for the notification event information.

Since :
5.5

Enumeration for the type of notification event.

Since :
5.5
typedef void* noti_ex_geometry_h

The handle for the geometry information.

Since :
5.5

Enumeration for notification_ex chat message type.

Since :
5.5
typedef int(* noti_ex_item_group_foreach_child_cb)(noti_ex_item_h handle, void *user_data)

Called to get the data of child item for each child of the group item.

Since :
5.5
Remarks:
handle must not be released
handle can be used only in the callback. handle will be freed after the callback exists.
Parameters:
[in]handleThe notification_ex item handle
[in]user_dataThe user data
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
See also:
noti_ex_item_h
noti_ex_item_group_foreach_child()
typedef void* noti_ex_item_h

The notification_ex item handle.

Since :
5.5
typedef void* noti_ex_item_info_h

The notification_ex item_info handle.

Since :
5.5

Enumeration for main types of notification_ex item.

Since :
5.5

Enumeration for notification_ex item policy.

Since :
5.5

Enumeration for notification_ex progress item types.

Since :
5.5

Enumeration for notification_ex item types.

Since :
5.5
typedef void* noti_ex_led_info_h

The handle for the LED information.

Since :
5.5
typedef void(* noti_ex_manager_events_add_cb)(noti_ex_manager_h handle, noti_ex_event_info_h info, noti_ex_item_h *added_items, int count, void *user_data)

Called when a notification addition event is received.

If this callback is set to NULL in event_callbacks, addition events cannot be received.

Since :
5.5
Parameters:
[in]handleThe manager handle
The handle is the same handle for which the callback was set
[in]infoThe handle that contains event information
The info can be used only in the callback. To use outside, make a copy.
The info will be freed after the callback exits.
[in]added_itemsThe item handles to be added
Each item in added_items should be destroyed with using noti_ex_item_destroy(), then added_items should be released with free().
[in]countThe count of the item to be added
[in]user_dataThe user data which was registered with callback
See also:
noti_ex_manager_h
noti_ex_event_info_h
noti_ex_item_h
noti_ex_event_info_clone()
noti_ex_item_destroy()
typedef void(* noti_ex_manager_events_delete_cb)(noti_ex_manager_h handle, noti_ex_event_info_h info, noti_ex_item_h deleted_item, void *user_data)

Called when a notification deletion event is received.

If this callback is set to NULL in event_callbacks, deletion events cannot be received.

Since :
5.5
Parameters:
[in]handleThe manager handle
The handle is the same handle for which the callback was set
[in]infoThe handle that contains event information
The info can be used only in the callback. To use outside, make a copy.
The info will be freed after the callback exits.
[in]deleted_itemThe item handle to be deleted
The deleted_item must be released using noti_ex_item_destroy().
[in]user_dataThe user data which was registered with callback
See also:
noti_ex_manager_h
noti_ex_event_info_h
noti_ex_item_h
noti_ex_event_info_clone()
noti_ex_item_destroy()
typedef void(* noti_ex_manager_events_error_cb)(noti_ex_manager_h handle, noti_ex_error_e error, int request_id, void *user_data)

Called when an error event is received.

The errors are passed from noti_ex_reporter_send_error(). If this callback is set to NULL in event_callbacks, error events cannot be received.

Since :
5.5
Parameters:
[in]handleThe manager handle
The handle is the same handle for which the callback was set
[in]errorThe error type
[in]request_idThe id of the request that occurred error
[in]user_dataThe user data which was registered with callback
See also:
noti_ex_manager_h
noti_ex_error_e
typedef void(* noti_ex_manager_events_update_cb)(noti_ex_manager_h handle, noti_ex_event_info_h info, noti_ex_item_h updated_item, void *user_data)

Called when a notification update event is received.

If this callback is set to NULL in event_callbacks, update events cannot be received.

Since :
5.5
Parameters:
[in]handleThe manager handle
The handle is the same handle for which the callback was set
[in]infoThe handle that contains event information
The info can be used only in the callback. To use outside, make a copy.
The info will be freed after the callback exits.
[in]updated_itemThe item handle to be updated
The updated_item must be released using noti_ex_item_destroy().
[in]user_dataThe user data which was registered with callback
See also:
noti_ex_manager_h
noti_ex_event_info_h
noti_ex_item_h
noti_ex_event_info_clone()
noti_ex_item_destroy()
typedef void* noti_ex_manager_h

The notification_ex manager handle.

Since :
5.5
typedef void* noti_ex_multi_lang_h

The notification_ex multi-language item handle.

Since :
5.5
typedef void* noti_ex_padding_h

The handle for the padding information.

Since :
5.5
typedef void(* noti_ex_reporter_events_error_cb)(noti_ex_reporter_h handle, noti_ex_error_e error, int request_id, void *user_data)

Called when the error event is received.

The errors are passed from noti_ex_manager_send_error(). If this callback is set to NULL in event_callbacks, error events cannot be received.

Since :
5.5
Parameters:
[in]handleThe reporter handle
The handle is the same handle for which the callback was set
[in]errorThe error type
[in]request_idThe id of the request that occurred error
[in]user_dataThe user data which was registered with callback
See also:
noti_ex_reporter_h
noti_ex_error_e
typedef void(* noti_ex_reporter_events_event_cb)(noti_ex_reporter_h handle, noti_ex_event_info_h info, noti_ex_item_h *items, int count, void *user_data)

Called when the notification event is received.

If this callback is set to NULL in event_callbacks, notification events cannot be received.

Since :
5.5
Parameters:
[in]handleThe reporter handle
The handle is the same handle for which the callback was set
[in]infoThe handle that contains event information
The info can be used only in the callback. To use outside, make a copy.
The info will be freed after the callback exits.
[in]itemsThe target items of event
Each item in items must be released using noti_ex_item_destroy(), then items must be released using free().
[in]countThe count of items
[in]user_dataThe user data which was registered with callback
See also:
noti_ex_reporter_h
noti_ex_event_info_h
noti_ex_item_h
noti_ex_event_info_clone()
noti_ex_item_destroy()
typedef void* noti_ex_reporter_h

The notification_ex reporter handle.

Since :
5.5
typedef void* noti_ex_style_h

The handle for the style information.

Since :
5.5

Enumeration Type Documentation

Enumeration for notification_ex action type.

Since :
5.5
Enumerator:
NOTI_EX_ACTION_TYPE_NULL 

Notification_ex action is null

NOTI_EX_ACTION_TYPE_APP_CONTROL 

Notification_ex action with app control

NOTI_EX_ACTION_TYPE_VISIBILITY 

Notification_ex action for visibility

NOTI_EX_ACTION_TYPE_CUSTOM 

Notification_ex action for custom action

Enumeration for notification errors.

Since :
5.5
Enumerator:
NOTI_EX_ERROR_NONE 

Success

NOTI_EX_ERROR_INVALID_PARAMETER 

Invalid parameter

NOTI_EX_ERROR_OUT_OF_MEMORY 

Out of memory

NOTI_EX_ERROR_IO_ERROR 

I/O error

NOTI_EX_ERROR_PERMISSION_DENIED 

Permission denied

NOTI_EX_ERROR_FROM_DB 

Error from DB query

NOTI_EX_ERROR_ALREADY_EXIST_ID 

Already exist private ID

NOTI_EX_ERROR_FROM_DBUS 

Error from DBus

NOTI_EX_ERROR_NOT_EXIST_ID 

Not exist private ID

NOTI_EX_ERROR_SERVICE_NOT_READY 

No response from notification service

Enumeration for the type of notification event.

Since :
5.5
Enumerator:
NOTI_EX_EVENT_POST 

Post the notification

NOTI_EX_EVENT_UPDATE 

Update the notification

NOTI_EX_EVENT_DELETE 

Delete the notification

NOTI_EX_EVENT_GET 

Get the notification

NOTI_EX_EVENT_ERROR 

Error occurs

NOTI_EX_EVENT_DELETE_ALL 

Delete all notifications

Enumeration for notification_ex chat message type.

Since :
5.5
Enumerator:
NOTI_EX_ITEM_CHAT_MESSAGE_TYPE_USER 

The user of chat message

NOTI_EX_ITEM_CHAT_MESSAGE_TYPE_SENDER 

The sender of chat message

NOTI_EX_ITEM_CHAT_MESSAGE_TYPE_NONE 

Not user or sender

Enumeration for main types of notification_ex item.

Since :
5.5
Enumerator:
NOTI_EX_ITEM_MAIN_TYPE_NONE 

None

NOTI_EX_ITEM_MAIN_TYPE_TITLE 

Main title. This main type is valid only for items of type NOTI_EX_ITEM_TYPE_TEXT.

NOTI_EX_ITEM_MAIN_TYPE_CONTENTS 

Main contents. This main type is valid only for items of type NOTI_EX_ITEM_TYPE_TEXT.

NOTI_EX_ITEM_MAIN_TYPE_ICON 

Main icon. This main type is valid only for items of type NOTI_EX_ITEM_TYPE_IMAGE.

NOTI_EX_ITEM_MAIN_TYPE_BUTTON 

Main button. This main type is valid only for items of type NOTI_EX_ITEM_TYPE_BUTTON.

Enumeration for notification_ex item policy.

Since :
5.5
Enumerator:
NOTI_EX_ITEM_POLICY_NONE 

No policy

NOTI_EX_ITEM_POLICY_ON_BOOT_CLEAR 

On boot clear

NOTI_EX_ITEM_POLICY_SIM_MODE 

SIM mode

NOTI_EX_ITEM_POLICY_DISABLE_AUTO_DELETE 

Disable auto delete

Enumeration for notification_ex progress item types.

Since :
5.5
Enumerator:
NOTI_EX_ITEM_PROGRESS_TYPE_DEFAULT 

Default

NOTI_EX_ITEM_PROGRESS_TYPE_TIME 

Time

NOTI_EX_ITEM_PROGRESS_TYPE_PERCENT 

Percent

NOTI_EX_ITEM_PROGRESS_TYPE_PENDING 

Pending

Enumeration for notification_ex item types.

Since :
5.5
Enumerator:
NOTI_EX_ITEM_TYPE_NULL 

Notification_ex item is null

NOTI_EX_ITEM_TYPE_TEXT 

Notification_ex item for text

NOTI_EX_ITEM_TYPE_IMAGE 

Notification_ex item for image

NOTI_EX_ITEM_TYPE_ICON 

Notification_ex item for icon

NOTI_EX_ITEM_TYPE_BUTTON 

Notification_ex item for button

NOTI_EX_ITEM_TYPE_CHAT_MESSAGE 

Notification_ex item for chat message

NOTI_EX_ITEM_TYPE_CHECKBOX 

Notification_ex item for check box

NOTI_EX_ITEM_TYPE_ICON_TEXT 

Notification_ex item for icon and text

NOTI_EX_ITEM_TYPE_INPUT_SELECTOR 

Notification_ex item for input selector

NOTI_EX_ITEM_TYPE_GROUP 

Notification_ex item for group

NOTI_EX_ITEM_TYPE_ENTRY 

Notification_ex item for entry

NOTI_EX_ITEM_TYPE_PROGRESS 

Notification_ex item for progress

NOTI_EX_ITEM_TYPE_TIME 

Notification_ex item for time

NOTI_EX_ITEM_TYPE_CUSTOM 

Notification_ex item for custom item


Function Documentation

int noti_ex_action_app_control_create ( noti_ex_action_h handle,
app_control_h  app_control,
const char *  extra 
)

Creates the notification_ex action handle with app control handle.

The notification_ex can define the action with noti_ex_action_h. If it is necessary to use app control handle for an action, the app control handle must be set in notification_ex action handle. extra can be used to pass user defined data and the extra data can be obtained from an action handle using noti_ex_action_get_extra().

Since :
5.5
Remarks:
handle must be released using noti_ex_action_destroy(). app_control must be released after noti_ex_action_app_control_create() function is called.
Parameters:
[out]handleThe notification_ex action handle
[in]app_controlThe app control handle
[in]extraThe extra data
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_action_h
noti_ex_action_destroy()
noti_ex_action_get_extra()
Sample code:
#include <notification_ex.h>

{
    int ret;
    app_control_h app_control = NULL;
    noti_ex_action_h appcontrol_action = NULL;

    app_control_create(&app_control);
    app_control_set_app_id(app_control, "temp_appid");

    ret = noti_ex_action_app_control_create(&appcontrol_action, app_control, NULL);

    app_control_destroy(app_control);
}
int noti_ex_action_app_control_get ( noti_ex_action_h  handle,
app_control_h app_control 
)

Gets the app control handle from notification_ex action.

Since :
5.5
Remarks:
The app_control should be released using app_control_destroy().
Parameters:
[in]handleThe notification_ex action handle
[out]app_controlThe app control handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
noti_ex_action_app_control_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    app_control_h app_control = NULL;

    ret = noti_ex_action_app_control_get(appcontrol_action, &app_control);
}

Sets the app control handle for notification_ex action.

Since :
5.5
Parameters:
[in]handleThe notification_ex action handle
[in]app_controlThe app control handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
noti_ex_action_app_control_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    app_control_h app_control = NULL;

    app_control_create(&app_control);
    app_control_set_app_id(app_control, "new_appid");

    ret = noti_ex_action_app_control_set(appcontrol_action, app_control);
}

Releases the notification_ex action handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex action handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_action_destroy(action);
}

Executes the action for a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex action handle
[in]itemThe notification_ex item handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h button_item = NULL;
    noti_ex_action_h action = NULL;

    ret = noti_ex_action_visibility_create(&action, NULL);
    ret = noti_ex_item_button_create(&button_item, "button_id", "button_title");
    ret = noti_ex_item_set_action(button_item, action);

    ret = noti_ex_action_execute(action, button_item);
}
int noti_ex_action_get_extra ( noti_ex_action_h  handle,
char **  extra 
)

Gets the extra data for an action.

Since :
5.5
Remarks:
extra must be released using free().
Parameters:
[in]handleThe notification_ex action handle
[out]extraThe extra data
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *extra = NULL;

    ret = noti_ex_action_get_extra(action, &extra);
}
int noti_ex_action_get_type ( noti_ex_action_h  handle,
int *  type 
)

Gets the type of an action.

The action type is equal to one of the values of noti_ex_action_type_e

Since :
5.5
Parameters:
[in]handleThe notification_ex action handle
[out]typeThe type of action
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
noti_ex_action_type_e
Sample code:
#include <notification_ex.h>

{
    int ret;
    int type = NOTI_EX_ACTION_TYPE_NULL;

    ret = noti_ex_action_get_type(action, &type);

    if (type == NOTI_EX_ACTION_TYPE_VISIBILITY) {
        // Do something
    }
}
int noti_ex_action_is_local ( noti_ex_action_h  handle,
bool *  local 
)

Gets the local state of an action.

Since :
5.5
Parameters:
[in]handleThe notification_ex action handle
[out]localThe local state of action
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    bool local;

    ret = noti_ex_action_is_local(action, &local);
}
int noti_ex_action_visibility_create ( noti_ex_action_h handle,
const char *  extra 
)

Creates the notification_ex action handle to control visibility.

The notification_ex can define the action with noti_ex_action_h. If it is necessary to control visibility of the notification_ex item, the notification_ex action handle has to be created as a visibility action. extra can be used to pass user defined data and the extra data can be obtained from an action handle using noti_ex_action_get_extra().

Since :
5.5
Remarks:
handle must be released using noti_ex_action_destroy().
Parameters:
[out]handleThe notification_ex action handle
[in]extraThe extra data
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_action_h
noti_ex_action_destroy()
noti_ex_action_get_extra()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_action_h visibility_action = NULL;

    ret = noti_ex_action_visibility_create(&visibility_action, NULL);
}
int noti_ex_action_visibility_set ( noti_ex_action_h  handle,
const char *  id,
bool  visible 
)

Sets the visibility state for notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex action handle
[in]idThe id of notification_ex item
[in]visibleThe visibility state
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_action_h
noti_ex_action_visibility_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h button_item = NULL;
    noti_ex_action_h action = NULL;

    ret = noti_ex_item_button_create(&button_item, "button_id1", "button_title");

    ret = noti_ex_action_visibility_create(&action, NULL);
    ret = noti_ex_action_visibility_set(action, "button_id1", true);
    ret = noti_ex_action_visibility_set(action, "button_id2", false);

    ret = noti_ex_item_set_action(button_item, action);
}
int noti_ex_color_create ( noti_ex_color_h handle,
unsigned char  a,
unsigned char  r,
unsigned char  g,
unsigned char  b 
)

Creates the notification_ex color handle.

Color information can be defined as a notification_ex color handle with alpha, red, green, blue value.

Since :
5.5
Remarks:
handle must be released using noti_ex_color_destroy().
Parameters:
[out]handleThe notification_ex color handle
[in]aThe alpha value
[in]rThe red value
[in]gThe green value
[in]bThe blue value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_color_h
noti_ex_color_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_color_h color = NULL;

    ret = noti_ex_color_create(&color, 0, 0, 0, 0);
}

Releases a notification_ex color handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex color handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_color_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_color_destroy(color);
}
int noti_ex_color_get_alpha ( noti_ex_color_h  handle,
unsigned char *  val 
)

Gets the alpha value of a color.

Since :
5.5
Parameters:
[in]handleThe notification_ex color handle
[out]valThe alpha value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_color_h
noti_ex_color_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    unsigned char alpha;

    ret = noti_ex_color_get_alpha(color, &alpha);
}
int noti_ex_color_get_blue ( noti_ex_color_h  handle,
unsigned char *  val 
)

Gets the blue value of a color.

Since :
5.5
Parameters:
[in]handleThe notification_ex color handle
[out]valThe blue value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_color_h
noti_ex_color_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    unsigned char blue;

    ret = noti_ex_color_get_blue(color, &blue);
}
int noti_ex_color_get_green ( noti_ex_color_h  handle,
unsigned char *  val 
)

Gets the green value of a color.

Since :
5.5
Parameters:
[in]handleThe notification_ex color handle
[out]valThe green value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_color_h
noti_ex_color_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    unsigned char green;

    ret = noti_ex_color_get_green(color, &green);
}
int noti_ex_color_get_red ( noti_ex_color_h  handle,
unsigned char *  val 
)

Gets the red value of a color.

Since :
5.5
Parameters:
[in]handleThe notification_ex color handle
[out]valThe red value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_color_h
noti_ex_color_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    unsigned char red;

    ret = noti_ex_color_get_red(color, &red);
}

Clones the notification event info handle.

The event for notification item is defined as notification event info handle.

Since :
5.5
Remarks:
cloned_handle must be released using noti_ex_event_info_destroy().
Parameters:
[in]handleThe notification event info handle to be cloned
[out]cloned_handleThe notification event info handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_event_info_h
noti_ex_event_info_destroy()
Sample code:
#include <notification_ex.h>

void _manager_events_update_cb(noti_ex_manager_h handle,
        noti_ex_event_info_h info, noti_ex_item_h updated_item, void *user_data) {

    int ret;
    noti_ex_event_info_h cloned = NULL;

    ret = noti_ex_event_info_clone(info, &cloned);
}

Releases the notification event info handle.

Since :
5.5
Parameters:
[in]handleThe notification event info handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_event_info_h
Sample code:
#include <notification_ex.h>

void _manager_events_update_cb(noti_ex_manager_h handle,
        noti_ex_event_info_h info, noti_ex_item_h updated_item, void *user_data) {

    int ret;
    noti_ex_event_info_h cloned = NULL;

    ret = noti_ex_event_info_clone(info, &cloned);
    ret = noti_ex_event_info_destroy(cloned);
}
int noti_ex_event_info_get_channel ( noti_ex_event_info_h  handle,
char **  channel 
)

Gets the channel of an event.

Since :
5.5
Remarks:
channel must be released using free().
Parameters:
[in]handleThe notification event info handle
[out]channelThe channel of event
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_event_info_h
noti_ex_event_info_clone()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *channel = NULL;

    ret = noti_ex_event_info_get_channel(event_handle, &channel);
}

Gets the type of an event.

Since :
5.5
Parameters:
[in]handleThe notification event info handle
[out]event_typeThe type of event
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_event_info_h
noti_ex_event_info_clone()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_event_info_type_e type;

    ret = noti_ex_event_info_get_event_type(event_handle, &type);
}
int noti_ex_event_info_get_item_id ( noti_ex_event_info_h  handle,
char **  item_id 
)

Gets the id of a notification_ex item.

Since :
5.5
Remarks:
item_id must be released using free().
Parameters:
[in]handleThe notification event info handle
[out]item_idThe id of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_event_info_h
noti_ex_event_info_clone()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *item_id = NULL;

    ret = noti_ex_event_info_get_item_id(event_handle, &item_id);
}
int noti_ex_event_info_get_owner ( noti_ex_event_info_h  handle,
char **  owner 
)

Gets the app id of event owner.

Since :
5.5
Remarks:
owner must be released using free().
Parameters:
[in]handleThe notification event info handle
[out]ownerThe app id of event owner
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_event_info_h
noti_ex_event_info_clone()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *owner = NULL;

    ret = noti_ex_event_info_get_owner(event_handle, &owner);
}
int noti_ex_event_info_get_request_id ( noti_ex_event_info_h  handle,
int *  req_id 
)

Gets the id of request for an event.

Since :
5.5
Parameters:
[in]handleThe notification event info handle
[out]req_idThe id of request for event
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_event_info_h
noti_ex_event_info_clone()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int request_id;

    ret = noti_ex_event_info_get_request_id(event_handle, &request_id);
}
int noti_ex_geometry_create ( noti_ex_geometry_h handle,
int  x,
int  y,
int  w,
int  h 
)

Creates the notification_ex geometry handle.

Geometry information can be defined as a notification_ex geometry handle with x, y, width and height value.

Since :
5.5
Remarks:
handle must be released using noti_ex_geometry_destroy().
Parameters:
[out]handleThe notification_ex geometry handle
[in]xThe x value
[in]yThe y value
[in]wThe width value
[in]hThe height value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_geometry_h
noti_ex_geometry_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_geometry_h geometry = NULL;

    ret = noti_ex_geometry_create(&geometry, 0, 0, 0, 0);
}

Releases the notification_ex geometry handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex geometry handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_geometry_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_geometry_destroy(geometry);
}
int noti_ex_geometry_get_height ( noti_ex_geometry_h  handle,
int *  val 
)

Gets the height value.

Since :
5.5
Parameters:
[in]handleThe notification_ex geometry handle
[out]valThe height value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_geometry_h
noti_ex_geometry_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int height;

    ret = noti_ex_geometry_get_height(geometry, &height);
}
int noti_ex_geometry_get_width ( noti_ex_geometry_h  handle,
int *  val 
)

Gets the width value.

Since :
5.5
Parameters:
[in]handleThe notification_ex geometry handle
[out]valThe width value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_geometry_h
noti_ex_geometry_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int width;

    ret = noti_ex_geometry_get_width(geometry, &width);
}
int noti_ex_geometry_get_x ( noti_ex_geometry_h  handle,
int *  val 
)

Gets the x position value.

Since :
5.5
Parameters:
[in]handleThe notification_ex geometry handle
[out]valThe x value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_geometry_h
noti_ex_geometry_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int x;

    ret = noti_ex_geometry_get_x(geometry, &x);
}
int noti_ex_geometry_get_y ( noti_ex_geometry_h  handle,
int *  val 
)

Gets the y position value.

Since :
5.5
Parameters:
[in]handleThe notification_ex geometry handle
[out]valThe y value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_geometry_h
noti_ex_geometry_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int y;

    ret = noti_ex_geometry_get_y(geometry, &y);
}
int noti_ex_item_add_receiver ( noti_ex_item_h  handle,
const char *  receiver_group 
)

Adds the receiver group of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]receiver_groupThe receiver group
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_add_receiver(item_handle, NOTI_EX_RECEIVER_GROUP_INDICATOR);
}
int noti_ex_item_button_create ( noti_ex_item_h handle,
const char *  id,
const char *  title 
)

Creates the notification_ex item handle with a button.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to display the notification with a button, the notification_ex handle has to be created as a button item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
[in]titleThe title of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h button_item = NULL;

    ret = noti_ex_item_button_create(&button_item, "button_id", "button_title");
}
int noti_ex_item_button_get_title ( noti_ex_item_h  handle,
char **  title 
)

Gets the title of a button item.

Since :
5.5
Remarks:
title must be released using free().
If the multi-language handle is set by noti_ex_item_button_set_multi_language_title(),
it will return a multi-language title.
Parameters:
[in]handleThe notification_ex item handle
[out]titleThe title of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_button_create()
noti_ex_item_button_set_multi_language_title()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *title = NULL;

    ret = noti_ex_item_button_get_title(button_item, &title);
}

Sets the multi-language handle.

Since :
5.5
Remarks:
After the multi-language handle setted successfully, noti_ex_item_button_get_title()
will return the multi-language text.
The noti_ex_item_h handle keeps its own copy of noti_ex_multi_lang_h.
Therefore, you can destroy multi after it was set for @ handle.
You can pass NULL to multi, if you want to remove multi-language text.
Parameters:
[in]handleThe notification_ex button item handle
[in]multiThe multi-language handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_button_create()
noti_ex_multi_lang_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h button_item = NULL;
    noti_ex_multi_lang_h multi;

    ret = noti_ex_item_button_create(&button_item, "button_id", "button_title");
    ret = noti_ex_multi_lang_create(&multi, "_IDS_NOTI_TEST_", "Hi %d I'm %s", 33, "test");
    ret = noti_ex_item_button_set_multi_language_title(button_item, multi);
    noti_ex_multi_lang_destroy(multi);
}
int noti_ex_item_chat_message_create ( noti_ex_item_h handle,
const char *  id,
noti_ex_item_h  name,
noti_ex_item_h  text,
noti_ex_item_h  image,
noti_ex_item_h  time,
noti_ex_item_chat_message_type_e  message_type 
)

Creates the notification_ex item handle for the chat message.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to create a chat message notification, notification_ex handle has to be created as a chat message item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy(). name, text, image and time must not be released if the function returns NOTI_EX_ERROR_NONE. name, text, image and time will be released when handle is released. name and time are mandatory (cannot be null). Both text and image cannot be null.
Parameters:
[out]handleThe noti ex item handle
[in]idThe id of notification_ex item
[in]nameThe notification_ex item handle for name
[in]textThe notification_ex item handle for text
[in]imageThe notification_ex item handle for image
[in]timeThe notification_ex item handle for time
[in]message_typeThe type of chat message
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_chat_message_type_e
noti_ex_item_text_create()
noti_ex_item_image_create()
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h chatmessage_item = NULL;
    noti_ex_item_h name_handle = NULL;
    noti_ex_item_h text_handle = NULL;
    noti_ex_item_h image_handle = NULL;
    noti_ex_item_h time_handle = NULL;
    time_t current_time;

    noti_ex_item_text_create(&name_handle, "name_id", "name", NULL);
    noti_ex_item_text_create(&text_handle, "text_id", "text", NULL);
    noti_ex_item_image_create(&image_handle, "image_id", APP_IMAGE_FULL_PATH);

    time(&current_time);
    noti_ex_item_time_create(&time_handle, "time_id", current_time);

    ret = noti_ex_item_chat_message_create(&chatmessage_item, "message_id", name_handle,
                text_handle, image_handle, time_handle, NOTI_EX_ITEM_CHAT_MESSAGE_TYPE_USER);
}

Gets the notification_ex item handle for the chat message image.

The image is a notification_ex item handle created with noti_ex_item_image_create().

Since :
5.5
Remarks:
image should not be released.
The image is available until handle is released.
Parameters:
[in]handleThe notification_ex item handle
[out]imageThe notification_ex item handle with image
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_chat_message_create()
noti_ex_item_image_get_image_path()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h image_handle = NULL;
    char *image_path = NULL;

    ret = noti_ex_item_chat_message_get_image(chatmessage_item, &image_handle);
    ret = noti_ex_item_image_get_image_path(image_handle, &image_path);
}

Gets the type of chat message.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]message_typeThe type of chat message
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_chat_message_type_e
noti_ex_item_chat_message_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_chat_message_type_e type;

    ret = noti_ex_item_chat_message_get_message_type(chatmessage_item, &type);
}

Gets the notification_ex item handle for the chat message name.

The name is a notification_ex item handle created with noti_ex_item_text_create().

Since :
5.5
Remarks:
name should not be released.
The name is available until handle is released.
Parameters:
[in]handleThe notification_ex item handle
[out]nameThe notification_ex item handle with name
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_chat_message_create()
noti_ex_item_text_get_contents()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h name_handle = NULL;
    char *name = NULL;

    ret = noti_ex_item_chat_message_get_name(chatmessage_item, &name_handle);
    ret = noti_ex_item_text_get_contents(name_handle, &name);
}

Gets the notification_ex item handle for the chat message text.

The text is a notification_ex item handle created with noti_ex_item_text_create().

Since :
5.5
Remarks:
text should not be released.
The text is available until handle is released.
Parameters:
[in]handleThe notification_ex item handle
[out]textThe notification_ex item handle with text
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_chat_message_create()
noti_ex_item_text_get_contents()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h text_handle = NULL;
    char *text = NULL;

    ret = noti_ex_item_chat_message_get_text(chatmessage_item, &text_handle);
    ret = noti_ex_item_text_get_contents(text_handle, &text);
}

Gets the notification_ex item handle for the chat message time.

The time is notification_ex item handle created with noti_ex_item_time_create().

Since :
5.5
Remarks:
time should not be released.
The time is available until handle is released.
Parameters:
[in]handleThe notification_ex item handle
[out]timeThe notification_ex item handle with time
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_chat_message_create()
noti_ex_item_time_get_time()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h time_handle = NULL;
    time_t time_info;

    ret = noti_ex_item_chat_message_get_time(chatmessage_item, &time_handle);
    ret = noti_ex_item_time_get_time(time_handle, &time_info);
}
int noti_ex_item_check_type_exist ( noti_ex_item_h  handle,
int  type,
bool *  exist 
)

Checks if an item of a specified type is included in a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]typeThe type of a notification_ex item
[out]existThe state of if a type is included
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_type_e
Sample code:
#include <notification_ex.h>

{
    int ret;
    int type = NOTI_EX_ITEM_TYPE_ENTRY;
    bool exist;

    ret = noti_ex_item_check_type_exist(item_handle, type, &exist);
}
int noti_ex_item_checkbox_create ( noti_ex_item_h handle,
const char *  id,
const char *  title,
bool  checked 
)

Creates the notification_ex item handle with checkbox.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to display the notification with a checkbox, the notification_ex handle has to be created as a checkbox item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
[in]titleThe title of notification_ex item
[in]checkedThe check state of checkbox
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h checkbox_item = NULL;

    ret = noti_ex_item_checkbox_create(&checkbox_item, "checkbox_id", "checkbox_title", false);
}
int noti_ex_item_checkbox_get_check_state ( noti_ex_item_h  handle,
bool *  checked 
)

Gets the check state of a checkbox.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]checkedThe check state of a checkbox
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_checkbox_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    bool checked;

    ret = noti_ex_item_checkbox_get_check_state(checkbox_item, &checked);
}
int noti_ex_item_checkbox_get_title ( noti_ex_item_h  handle,
char **  title 
)

Gets the title of a checkbox.

Since :
5.5
Remarks:
title must be released using free().
If the multi-language handle is set by noti_ex_item_checkbox_set_multi_language_title(),
it will return a multi-language title.
Parameters:
[in]handleThe notification_ex item handle
[out]titleThe title of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_checkbox_create()
noti_ex_item_checkbox_set_multi_language_title()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *title = NULL;

    ret = noti_ex_item_checkbox_get_title(checkbox_item, &title);
}
int noti_ex_item_checkbox_set_check_state ( noti_ex_item_h  handle,
bool  checked 
)

Sets the check state of a checkbox.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]checkedThe check state of a checkbox
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_checkbox_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_checkbox_set_check_state(checkbox_item, true);
}

Sets the multi-language handle.

Since :
5.5
Remarks:
After the multi-language handle setted successfully,
noti_ex_item_checkbox_get_title() will return the multi-language text.
The noti_ex_item_h handle keeps its own copy of noti_ex_multi_lang_h.
Therefore, you can destroy multi after it was set for @ handle.
You can pass NULL to multi, if you want to remove the multi-language text.
Parameters:
[in]handleThe notification_ex item handle
[in]multiThe multi-language handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_checkbox_create()
noti_ex_item_checkbox_get_title()
noti_ex_multi_lang_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h checkbox_item = NULL;
    noti_ex_multi_lang_h multi;

    ret = noti_ex_item_checkbox_create(&checkbox_item, "checkbox_id", "checkbox_title", false);
    ret = noti_ex_multi_lang_create(&multi, "_IDS_NOTI_TEST_", "Hi %d I'm %s", 33, "test");
    ret = noti_ex_item_checkbox_set_multi_language_title(checkbox_item, multi);
    noti_ex_multi_lang_destroy(multi);
}

Releases the notification_ex item handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_destroy(item_handle);
}
int noti_ex_item_entry_create ( noti_ex_item_h handle,
const char *  id 
)

Creates the notification_ex item handle for an entry item.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to get the text input directly from the notification, the notification_ex handle has to be created as an entry item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h entry_item = NULL;

    ret = noti_ex_item_entry_create(&entry_item, "entry_id");
}
int noti_ex_item_entry_get_text ( noti_ex_item_h  handle,
char **  text 
)

Gets the text of an entry item.

Since :
5.5
Remarks:
text must be released using free().
If the multi-language handle is set by
noti_ex_item_entry_set_multi_language(), it will return a multi-language text.
Parameters:
[in]handleThe notification_ex item handle
[out]textThe text of entry item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_entry_create()
noti_ex_item_entry_set_multi_language()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *text = NULL;

    ret = noti_ex_item_entry_get_text(entry_item, &text);
}

Sets the multi-language handle.

Since :
5.5
Remarks:
After the multi-language handle setted successfully,
noti_ex_item_entry_get_text() will return the multi-language text.
The noti_ex_item_h handle keeps its own copy of noti_ex_multi_lang_h.
Therefore, you can destroy multi after it was set for @ handle.
You can pass NULL to multi, if you want to remove the multi-language text.
Parameters:
[in]handleThe notification_ex item handle
[in]multiThe multi-language handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_text_create()
noti_ex_item_text_set_multi_language()
noti_ex_item_text_get_contents()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h entry_item = NULL;
    noti_ex_multi_lang_h multi;

    ret = noti_ex_item_entry_create(&entry_item, "entry_id");
    ret = noti_ex_item_entry_set_multi_language(entry_item, multi);
    noti_ex_multi_lang_destroy(multi);
}
int noti_ex_item_entry_set_text ( noti_ex_item_h  handle,
const char *  text 
)

Sets the text of an entry item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]textThe text of entry item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_entry_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_entry_set_text(entry_item, "entry_text");
}
int noti_ex_item_find_by_id ( noti_ex_item_h  handle,
const char *  id,
noti_ex_item_h item 
)

Finds the notification_ex item handle by notification_ex item id.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]idThe id of notification_ex item
[in]itemThe notification_ex item handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h item = NULL;

    ret = noti_ex_item_find_by_id(item_handle, "find_id", &item);
}
int noti_ex_item_find_by_main_type ( noti_ex_item_h  handle,
int  type,
noti_ex_item_h item 
)

Finds the notification item of the specified main type.

Finds the item that matches the main type among the group items.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[in]handleThe notification_ex item handle
[in]typeThe main type
[out]itemThe notification_ex item handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_main_type_e
Sample code:
#include <notification_ex.h>

{
    noti_ex_item_h text_item = NULL;
    int type = NOTI_EX_ITEM_MAIN_TYPE_TITLE;
    int ret;

    ret = noti_ex_item_find_by_main_type(item_handle, type, &text_item);

    if (text_item != NULL) {
        // Do something
    }
}

Gets the action for a notification_ex item.

The action is defined as notification_ex action handle.

Since :
5.5
Remarks:
action must be released using noti_ex_action_destroy().
Parameters:
[in]handleThe notification_ex item handle
[out]actionThe notification_ex action handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_action_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_action_h action = NULL;

    ret = noti_ex_item_get_action(item_handle, &action);
}
int noti_ex_item_get_channel ( noti_ex_item_h  handle,
char **  channel 
)

Gets the channel of a notification_ex item.

Since :
5.5
Remarks:
channel must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]channelThe channel of a notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *channel;

    ret = noti_ex_item_get_channel(item_handle, &channel);
}
int noti_ex_item_get_enable ( noti_ex_item_h  handle,
bool *  enable 
)

Gets the enabled state of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]enableThe enable state
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    bool enable;

    ret = noti_ex_item_get_enable(item_handle, &enable);
}
int noti_ex_item_get_extension_data ( noti_ex_item_h  handle,
const char *  key,
bundle **  value 
)

Gets the extension data.

Since :
5.5
Remarks:
The value should be released using bundle_free().
Parameters:
[in]handleThe notification_ex item handle
[in]keyThe key
[out]valueThe bundle data
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *key = "ADDITIONAL_DATA_KEY";
    bundle *b;

    ret = noti_ex_item_get_extension_data(item_handle, key, &b);
    ...
    bundle_free(b);
}
int noti_ex_item_get_id ( noti_ex_item_h  handle,
char **  id 
)

Gets the id of a notification_ex item.

Since :
5.5
Remarks:
id must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]idThe id of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *id = NULL;

    ret = noti_ex_item_get_id(item_handle, &id);
}

Gets the information of a notification_ex item.

The information of notification_ex item is defined as notification_ex item info handle.

Since :
5.5
Remarks:
info should not be released.
info is available until handle is released.
Parameters:
[in]handleThe notification_ex item handle
[out]infoThe notification_ex item info handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_info_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_info_h item_info = NULL;

    ret = noti_ex_item_get_info(item_handle, &item_info);
}

Gets the LED information of a notification_ex item.

The LED information is defined as notification_ex LED info handle

Since :
5.5
Remarks:
led must be released using noti_ex_led_info_destroy().
Parameters:
[in]handleThe notification_ex item handle
[out]ledThe notification_ex LED info item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_led_info_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_led_info_h led_info = NULL;

    ret = noti_ex_item_get_led_info(item_handle, &led_info);
}
int noti_ex_item_get_main_type ( noti_ex_item_h  handle,
int *  type 
)

Gets the main type of a notification item.

The type is equal to one of the values of noti_ex_item_main_type_e.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]typeThe main type
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_main_type_e
Sample code:
#include <notification_ex.h>

{
    int ret;
    int type = NOTI_EX_ITEM_MAIN_TYPE_NONE;

    ret = noti_ex_item_get_main_type(item_handle, &type);

    if (type == NOTI_EX_ITEM_MAIN_TYPE_TITLE) {
        // Do something
    }
}
int noti_ex_item_get_ongoing_state ( noti_ex_item_h  handle,
bool *  ongoing 
)

Gets the value indicating whether a notification is currently ongoing.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]ongoingThe state of ongoing
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    bool ongoing;

    ret = noti_ex_item_get_ongoing_state(item_handle, &ongoing);
}
int noti_ex_item_get_policy ( noti_ex_item_h  handle,
int *  policy 
)

Gets the policy of a notification_ex item.

policy is equal to values of noti_ex_item_policy_e combined with bitwise 'or'.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]policyThe policy of a notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_policy_e
Sample code:
#include <notification_ex.h>

{
    int ret;
    int policy;

    ret = noti_ex_item_get_policy(item_handle, &policy);
}
int noti_ex_item_get_receiver_list ( noti_ex_item_h  handle,
char ***  list,
int *  count 
)

Gets the list of receiver group of a notification_ex item.

Since :
5.5
Remarks:
Each member of the list must be released using free(), then the list must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]listThe list of receiver group
[out]countThe count of list
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char **list = NULL;
    int count;

    ret = noti_ex_item_get_receiver_list(item_handle, &list, &count);
}
int noti_ex_item_get_sender_app_id ( noti_ex_item_h  handle,
char **  id 
)

Gets the sender app id of a notification_ex item.

Since :
5.5
Remarks:
id must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]idThe sender app id of a notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *app_id = NULL;

    ret = noti_ex_item_get_sender_app_id(item_handle, &app_id);
}
int noti_ex_item_get_sound_path ( noti_ex_item_h  handle,
char **  path 
)

Gets the sound path of a notification_ex item.

Since :
5.5
Remarks:
path must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]pathThe absolute path of sound for notification_ex item If not set, you will get NULL. If set default, you will get NOTI_EX_SOUND_TYPE_DEFAULT.
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *path = NULL;

    ret = noti_ex_item_get_sound_path(item_handle, &path);
}
int noti_ex_item_get_style ( noti_ex_item_h  handle,
noti_ex_style_h style 
)

Gets the style of a notification_ex item.

The style is defined as notification_ex style handle.

Since :
5.5
Remarks:
style must be released using noti_ex_style_destroy().
Parameters:
[in]handleThe notification_ex item handle
[out]styleThe notification_ex style handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_style_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_style_h style = NULL;

    ret = noti_ex_item_get_style(item_handle, &style);
}
int noti_ex_item_get_tag ( noti_ex_item_h  handle,
char **  tag 
)

Gets the tag of a notification_ex item.

Since :
5.5
Remarks:
tag must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]tagThe tag of a notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *tag = NULL;

    ret = noti_ex_item_get_tag(item_handle, &tag);
}
int noti_ex_item_get_type ( noti_ex_item_h  handle,
int *  type 
)

Gets the type of notification_ex item.

The item type is equal to one of the values of noti_ex_item_type_e.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]typeThe type of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_type_e
Sample code:
#include <notification_ex.h>

{
    int ret;
    int type = NOTI_EX_ITEM_TYPE_NULL;

    ret = noti_ex_item_get_type(item_handle, &type);

    if (type == NOTI_EX_ITEM_TYPE_BUTTON) {
        // Do something
    }
}
int noti_ex_item_get_vibration_path ( noti_ex_item_h  handle,
char **  path 
)

Gets the vibration path of a notification_ex item.

Since :
5.5
Remarks:
path must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]pathThe absolute path of vibration for a notification_ex item If not set, you will get NULL. If set default, you will get NOTI_EX_VIBRATION_TYPE_DEFAULT.
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *path = NULL;

    ret = noti_ex_item_get_vibration_path(item_handle, &path);
}
int noti_ex_item_get_visible ( noti_ex_item_h  handle,
bool *  visible 
)

Gets the visibility state of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]visibleThe visible state
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    bool visible;

    ret = noti_ex_item_get_visible(item_handle, &visible);
}

Adds the child to the group item.

Since :
5.5
Remarks:
child must not be released after calling this function
Parameters:
[in]handleThe notification_ex item handle
[in]childThe child notification_ex item handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_group_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;

    ret = noti_ex_item_group_create(&group_item, "group_id");
    ret = noti_ex_item_button_create(&child_item, "button_id", "button_title");
    ret = noti_ex_item_group_add_child(group_item, child_item);

    noti_ex_item_destroy(child_item);
}
int noti_ex_item_group_create ( noti_ex_item_h handle,
const char *  id 
)

Creates the group of notification_ex items.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to make the group of notification_ex items, the notification_ex handle has to be created as a group item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h group_item = NULL;

    ret = noti_ex_item_group_create(&group_item, "group_id");
}
int noti_ex_item_group_foreach_child ( noti_ex_item_h  handle,
noti_ex_item_group_foreach_child_cb  callback,
void *  user_data 
)

Gets the data of children from the group item.

The noti_ex_item_group_foreach_child_cb() is called for each child of the group item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]callbackThe callback function to get the children data
[in]user_dataThe user data to be passed to the callback function
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_group_foreach_child_cb()
Sample code:
#include <notification_ex.h>

int _ex_item_group_foreach_child_cb(noti_ex_item_h handle, void *user_data) {
    return 0;
}

{
    int ret;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;

    ret = noti_ex_item_group_create(&group_item, "group_id");
    ret = noti_ex_item_button_create(&child_item, "button_id", "button_title");
    ret = noti_ex_item_group_add_child(group_item, child_item);

    noti_ex_item_destroy(child_item);

    ret = noti_ex_item_group_foreach_child(group_item, _ex_item_group_foreach_child_cb, NULL);
}
int noti_ex_item_group_get_app_label ( noti_ex_item_h  handle,
char **  label 
)

Gets the label of application.

Since :
5.5
Remarks:
label must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]labelThe label of application
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_group_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *label = NULL;

    ret = noti_ex_item_group_get_app_label(group_item, &label);
}
int noti_ex_item_group_is_vertical ( noti_ex_item_h  handle,
bool *  vertical 
)

Gets the vertical state of group item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]verticalThe vertical state of group item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_group_create()
noti_ex_item_group_set_direction()
Sample code:
#include <notification_ex.h>

{
    int ret;
    bool vertical;

    ret = noti_ex_item_group_is_vertical(group_item, &vertical);
}
int noti_ex_item_group_remove_child ( noti_ex_item_h  handle,
const char *  item_id 
)

Removes the child from the group item by notification_ex item id.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]item_idThe id of notification_ex item that is child of group item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_group_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_group_remove_child(group_item, "child_id");
}
int noti_ex_item_group_set_direction ( noti_ex_item_h  handle,
bool  vertical 
)

Sets the direction of children in the group item.

If vertical state is true, the children of group item are placed vertically. If vertical state is false, the children of group item are placed horizontally.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]verticalThe vertical state of group item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_group_create()
noti_ex_item_group_is_vertical().
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_group_set_direction(group_item, true);
}
int noti_ex_item_image_create ( noti_ex_item_h handle,
const char *  id,
const char *  image_path 
)

Creates the notification_ex item handle with an image.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to display the notification with an image, the notification_ex handle has to be created as an image item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
[in]image_pathThe absolute path of image
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h image_item = NULL;
    char *image_path[BUFLEN];

    char *shared_path = app_get_shared_resource_path();
    snprintf(image_path, BUFLEN, "%simage.png", shared_path);
    free(shared_path);

    ret = noti_ex_item_image_create(&image_item, "image_id", image_path);
}
int noti_ex_item_image_get_image_path ( noti_ex_item_h  handle,
char **  image_path 
)

Gets the path of image.

Since :
5.5
Remarks:
image_path must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]image_pathThe absolute path of image
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_image_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *path = NULL;

    ret = noti_ex_item_image_get_image_path(image_item, &path);
}
int noti_ex_item_info_get_delete_time ( noti_ex_item_info_h  handle,
int *  delete_time 
)

Gets the time to delete the notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item info handle
[out]delete_timeThe time to delete notification, in seconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_info_h
noti_ex_item_get_info()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int delete_time;
    noti_ex_item_info_h item_info = NULL;

    ret = noti_ex_item_get_info(item_handle, &item_info);

    ret = noti_ex_item_info_get_delete_time(item_info, &delete_time);
}
int noti_ex_item_info_get_hide_time ( noti_ex_item_info_h  handle,
int *  hide_time 
)

Gets the time to hide the notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item info handle
[out]hide_timeThe time to hide notification, in seconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_info_h
noti_ex_item_get_info()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int hide_time;
    noti_ex_item_info_h item_info = NULL;

    ret = noti_ex_item_get_info(item_handle, &item_info);

    ret = noti_ex_item_info_get_hide_time(item_info, &hide_time);
}
int noti_ex_item_info_get_time ( noti_ex_item_info_h  handle,
time_t *  time 
)

Gets the time information.

Since :
5.5
Parameters:
[in]handleThe notification_ex item info handle
[out]timeThe time information
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_info_h
noti_ex_item_get_info()
Sample code:
#include <notification_ex.h>

{
    int ret;
    time_t time;
    noti_ex_item_info_h item_info = NULL;

    ret = noti_ex_item_get_info(item_handle, &item_info);

    ret = noti_ex_item_info_get_time(item_info, &time);
}
int noti_ex_item_info_set_delete_time ( noti_ex_item_info_h  handle,
int  delete_time 
)

Sets the time to delete the notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item info handle
[out]delete_timeThe time to delete notification, in seconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_info_h
noti_ex_item_get_info()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_info_h item_info = NULL;

    ret = noti_ex_item_get_info(item_handle, &item_info);

    ret = noti_ex_item_info_set_delete_time(item_info, 5);
}
int noti_ex_item_info_set_hide_time ( noti_ex_item_info_h  handle,
int  hide_time 
)

Sets the time to hide the notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item info handle
[in]hide_timeThe time to hide notification, in seconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_info_h
noti_ex_item_get_info()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_info_h item_info = NULL;

    ret = noti_ex_item_get_info(item_handle, &item_info);

    ret = noti_ex_item_info_set_hide_time(action, 5);
}
int noti_ex_item_input_selector_create ( noti_ex_item_h handle,
const char *  id 
)

Creates the notification_ex item handle with input selector.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to be display the notification with selector to select predefined input, the notification_ex handle has to be created as an input selector item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h selector_item = NULL;

    ret = noti_ex_item_input_selector_create(&selector_item, "selector_id");
}
int noti_ex_item_input_selector_get_contents ( noti_ex_item_h  handle,
char ***  list,
int *  count 
)

Gets the contents that can be selected by input selector.

Since :
5.5
Remarks:
Each item in the list must be released using free(), then the list must be released using free().
If the multi-language handle is set by noti_ex_item_input_selector_set_multi_language_contents(),
it will return a multi-language contents.
Parameters:
[in]handleThe notification_ex item handle
[out]listThe list of contents
[out]countThe count of contents
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_input_selector_create()
noti_ex_item_input_selector_set_contents()
noti_ex_item_input_selector_set_multi_language_contents()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char **list = NULL;
    int count = 0;

    ret = noti_ex_item_input_selector_get_contents(selector_item, &list, &count);
}
int noti_ex_item_input_selector_set_contents ( noti_ex_item_h  handle,
const char **  contents,
int  count 
)

Sets the contents for input selector item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]contentsThe list of contents
[in]countThe count of contents
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_input_selector_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    const char *contents[] = {"What's up?", "On my way", "Nice"};
    int count = 3;

    ret = noti_ex_item_input_selector_set_contents(selector_item, contents, count);
}
int noti_ex_item_input_selector_set_multi_language_contents ( noti_ex_item_h  handle,
noti_ex_multi_lang_h multi_language_list,
int  count 
)

Sets the multi-language contents for input selector item.

Since :
5.5
Remarks:
After the multi-language handle setted successfully,
noti_ex_item_input_selector_get_contents() will return the multi-language text.
The noti_ex_item_h handle keeps its own copy of noti_ex_multi_lang_h list.
Therefore, you can destroy multi_language_list after it was set for @ handle.
You can pass NULL to multi_language_list, if you want to remove the multi-language text.
Parameters:
[in]handleThe notification_ex item handle
[in]multi_language_listThe list of noti_ex_multi_lang_h
[in]countThe count of contents
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_input_selector_create()
noti_ex_item_input_selector_get_contents()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_multi_lang_h *contents[] = {multi1, multi2, multi3};
    int count = 3;

    ret = noti_ex_item_input_selector_set_multi_language_contents(selector_item, contents, count);
}
int noti_ex_item_progress_create ( noti_ex_item_h handle,
const char *  id,
float  min,
float  current,
float  max 
)

Creates the notification_ex item handle with progress.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to be display the notification with progress, the notification_ex handle has to be created as a progress item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
[in]minThe minimum value of progress
[in]currentThe current value of progress
[in]maxThe maximum value of progress
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h progress_item = NULL;

    ret = noti_ex_item_progress_create(&progress_item, "progress_id", 0, 50, 100);
}
int noti_ex_item_progress_get_current ( noti_ex_item_h  handle,
float *  current 
)

Gets the current value of progress.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]currentThe current value of progress
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_progress_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    float current;

    ret = noti_ex_item_progress_get_current(progress_item, &current);
}
int noti_ex_item_progress_get_max ( noti_ex_item_h  handle,
float *  max 
)

Gets the maximum value of progress.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]maxThe maximum value of progress
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_progress_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    float max;

    ret = noti_ex_item_progress_get_max(progress_item, &max);
}
int noti_ex_item_progress_get_min ( noti_ex_item_h  handle,
float *  min 
)

Gets the minimum value of progress.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]minThe minimum value of progress
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_progress_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    float min;

    ret = noti_ex_item_progress_get_min(progress_item, &min);
}
int noti_ex_item_progress_get_type ( noti_ex_item_h  handle,
int *  type 
)

Gets the type of progress. The type is equal to one of the values of noti_ex_item_progress_type_e.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[out]typeThe type of progress
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_progress_type_e
noti_ex_item_progress_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int type;

    ret = noti_ex_item_progress_get_type(progress_item, &type);
}
int noti_ex_item_progress_set_current ( noti_ex_item_h  handle,
float  current 
)

Sets the current value of progress.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]currentThe current value of progress
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_progress_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_progress_set_current(progress_item, 70);
}
int noti_ex_item_progress_set_type ( noti_ex_item_h  handle,
int  type 
)

Sets the type of progress.

The type is equal to one of the values of noti_ex_item_progress_type_e.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]typeThe type of progress
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_progress_type_e
noti_ex_item_progress_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h progress_item = NULL;
    int type = NOTI_EX_ITEM_PROGRESS_TYPE_PERCENT;

    ret = noti_ex_item_progress_create(&progress_item, "progress_id", 0, 50, 100);
    ret = noti_ex_item_progress_set_type(progress_item, type);
}
int noti_ex_item_remove_receiver ( noti_ex_item_h  handle,
const char *  receiver_group 
)

Removes the receiver group from a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]receiver_groupThe receiver group
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_remove_receiver(item_handle, NOTI_EX_RECEIVER_GROUP_INDICATOR);
}

Sets the action of a notification_ex item.

The action is defined as notification_ex action handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]actionThe notification_ex action handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_action_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h item_handle = NULL;
    noti_ex_action_h action = NULL;

    ret = app_control_create(&app_control);
    ret = app_control_set_app_id(app_control, "appid");
    ret = noti_ex_action_app_control_create(&action, app_control, NULL);

    ret = noti_ex_item_button_create(&item_handle, "button_id", "button_title");

    ret = noti_ex_item_set_action(item_handle, action);

    app_control_destroy(app_control);
}
int noti_ex_item_set_channel ( noti_ex_item_h  handle,
const char *  channel 
)

Sets the channel of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]channelThe channel of a notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_channel(item_handle, "channel");
}
int noti_ex_item_set_enable ( noti_ex_item_h  handle,
bool  enable 
)

Sets the enabled state of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]enableThe enable state
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_enable(item_handle, true);
}
int noti_ex_item_set_extension_data ( noti_ex_item_h  handle,
const char *  key,
bundle value 
)

Sets the extension data.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]keyThe key
[in]valueThe bundle data
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *key = "ADDITIONAL_DATA_KEY";
    bundle *b = bundle_create();
    bundle_add_str(b, "key", "value");

    ret = noti_ex_item_set_extension_data(item_handle, key, b);
    bundle_free(b);
}
int noti_ex_item_set_id ( noti_ex_item_h  handle,
const char *  id 
)

Sets the id of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]idThe id of notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_id(item_handle, "new_id");
}

Sets the LED information of a notification_ex item.

The LED information is defined as notification_ex LED info handle

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]ledThe notification_ex LED info item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_led_info_h
noti_ex_led_info_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_led_info(item_handle, led_info);
}
int noti_ex_item_set_main_type ( noti_ex_item_h  handle,
const char *  id,
int  type 
)

Sets the main type of a notification item.

Use this function to configure main type among multiple items. In other words, if there is only one item, it should not be used. The type is equal to one of the values of noti_ex_item_main_type_e.

Since :
5.5
Remarks:
When set to a specific type, the previous main item of the same type is canceled.
Parameters:
[in]handleThe notification_ex item handle
[in]idThe ID of notification_ex item
[in]typeThe main type
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_main_type_e
Sample code:
#include <notification_ex.h>

{
    noti_ex_item_h text_item = NULL;
    noti_ex_item_h group_item = NULL;
    int type = NOTI_EX_ITEM_MAIN_TYPE_TITLE;
    int ret;

    ret = noti_ex_item_group_create(&group_item, "group_id");
    ret = noti_ex_item_text_create(&text_item, "text_id", "text", "hyperlink");
    ret = noti_ex_item_group_add_child(group_item, text_item);
    noti_ex_item_destroy(text_item);

    ret = noti_ex_item_set_main_type(group_item, "text_id", type);
}
int noti_ex_item_set_ongoing_state ( noti_ex_item_h  handle,
bool  ongoing 
)

Sets the value indicating whether a notification is currently ongoing.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]ongoingThe state of ongoing
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_ongoing_state(item_handle, true);
}
int noti_ex_item_set_policy ( noti_ex_item_h  handle,
int  policy 
)

Sets the policy of a notification_ex item.

policy should be set to values of noti_ex_item_policy_e combined with bitwise 'or'.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]policyThe policy of a notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_policy_e
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_policy(item_handle,
            NOTI_EX_ITEM_POLICY_ON_BOOT_CLEAR | NOTI_EX_ITEM_POLICY_SIM_MODE);
}
int noti_ex_item_set_sound_path ( noti_ex_item_h  handle,
const char *  path 
)

Sets the sound path of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]pathThe absolute path of sound for notification_ex item If you want to set a default sound, enter NOTI_EX_SOUND_TYPE_DEFAULT.
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_sound_path(item_handle, "sound_path");
}

Sets the style of a notification_ex item.

The style is defined as notification_ex style handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]styleThe notification_ex style handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_style_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_style(item_handle, style);
}
int noti_ex_item_set_tag ( noti_ex_item_h  handle,
const char *  tag 
)

Sets the tag of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]tagThe tag of a notification_ex item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_tag(item_handle, "item_tag");
}
int noti_ex_item_set_vibration_path ( noti_ex_item_h  handle,
const char *  path 
)

Sets the vibration path of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]pathThe absolute path of vibration for notification_ex item If you want to set a default sound, enter NOTI_EX_VIBRATION_TYPE_DEFAULT.
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_vibration_path(item_handle, "vibration_path");
}
int noti_ex_item_set_visible ( noti_ex_item_h  handle,
bool  visible 
)

Sets the visibility state of a notification_ex item.

Since :
5.5
Parameters:
[in]handleThe notification_ex item handle
[in]visibleThe visible state
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_set_visible(item_handle, true);
}
int noti_ex_item_text_create ( noti_ex_item_h handle,
const char *  id,
const char *  text,
const char *  hyperlink 
)

Creates the notification_ex item handle with text.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to be display the notification with text, the notification_ex handle has to be created as a text item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
[in]textThe text of text item
[in]hyperlinkThe hyperlink of text item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h text_item = NULL;

    ret = noti_ex_item_text_create(&text_item, "text_id", "text", "hyperlink");
}
int noti_ex_item_text_get_contents ( noti_ex_item_h  handle,
char **  contents 
)

Gets the text contents of the text item.

Since :
5.5
Remarks:
contents must be released using free().
If the multi-language handle is set by noti_ex_item_text_set_multi_language(),
it will return a multi-language content.
Parameters:
[in]handleThe notification_ex item handle
[out]contentsThe text contents
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_text_create()
noti_ex_item_text_set_multi_language()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *contents = NULL;

    ret = noti_ex_item_text_get_contents(text_item, &contents);
}
int noti_ex_item_text_get_hyperlink ( noti_ex_item_h  handle,
char **  hyperlink 
)

Gets the hyperlink of the text item.

Since :
5.5
Remarks:
hyperlink must be released using free().
Parameters:
[in]handleThe notification_ex item handle
[out]hyperlinkThe hyperlink
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_text_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *hyperlink = NULL;

    ret = noti_ex_item_text_get_hyperlink(text_item, &hyperlink);
}
int noti_ex_item_text_set_contents ( noti_ex_item_h  handle,
const char *  contents 
)

Sets the text contents of the text item.

Since :
5.5
Remarks:
If the multi-language handle is set by noti_ex_item_text_set_multi_language(),
it will return a multi-language content.
Parameters:
[in]handleThe notification_ex item handle
[in]contentsThe text contents
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
noti_ex_item_text_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_item_text_set_contents(text_item, "text_contents");
}

Sets the multi-language handle.

Since :
5.5
Remarks:
After the multi-language handle setted successfully,
noti_ex_item_text_get_contents() will return the multi-language text.
The noti_ex_item_h handle keeps its own copy of noti_ex_multi_lang_h.
Therefore, you can destroy multi after it was set for @ handle.
You can pass NULL to multi, if you want to remove the multi-language text.
Parameters:
[in]handleThe notification_ex item handle
[in]multiThe multi-language handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_text_create()
noti_ex_multi_lang_create()
noti_ex_item_text_get_contents()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h text_item = NULL;
    noti_ex_multi_lang_h multi;

    ret = noti_ex_item_text_create(&text_item, "text_id", "text", "hyperlink");
    ret = noti_ex_multi_lang_create(&multi, "_IDS_NOTI_TEST_", "Hi %d I'm %s", 33, "test");
    ret = noti_ex_item_text_set_multi_language(text_item, multi);
    noti_ex_multi_lang_destroy(multi);
}
int noti_ex_item_time_create ( noti_ex_item_h handle,
const char *  id,
time_t  time 
)

Creates the notification_ex item handle with time.

The notification_ex item is the predefined type of notifications. The notification can be created with one item or group of items. If the user wants to be display the notification with time, the notification_ex handle has to be created as a time item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[out]handleThe notification_ex item handle
[in]idThe id of notification_ex item
[in]timeThe time information
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_item_h time_item = NULL;
    time_t time_info;
    time(&time_info);

    ret = noti_ex_item_time_create(&time_item, "time_id", time_info);
}
int noti_ex_item_time_get_time ( noti_ex_item_h  handle,
time_t *  time 
)

Gets the time information of time item.

Since :
5.5
Remarks:
handle must be released using noti_ex_item_destroy().
Parameters:
[in]handleThe notification_ex item handle
[out]timeThe time information of time item
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter, if the item type is not correct, this error is returned
See also:
noti_ex_item_h
noti_ex_item_time_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    time_t time_info;

    ret = noti_ex_item_time_get_time(time_item, &time_info);
}

Creates the notification_ex LED info handle.

LED information can be defined as a notification_ex LED handle with color information. The color is the defined notification_ex color handle.

Since :
5.5
Remarks:
handle must be released using noti_ex_led_info_destroy(). color must not be released if the function returns NOTI_EX_ERROR_NONE. color will be released when handle is released.
Parameters:
[out]handleThe notification_ex LED info handle
[in]colorThe notification_ex color handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_led_info_h
noti_ex_color_h
noti_ex_led_info_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_led_info_h led_info = NULL;
    noti_ex_color_h color = NULL;

    ret = noti_ex_color_create(&color, 0, 0, 0, 0);

    ret = noti_ex_led_info_create(&led_info, color);
}

Releases the notification_ex LED info handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex LED info handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_led_info_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_led_info_destroy(led_info);
}

Gets the color information from LED info.

Since :
5.5
Remarks:
color must be released using noti_ex_color_destroy().
Parameters:
[in]handleThe notification_ex LED info handle
[out]colorThe notification_ex color handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_led_info_h
noti_ex_color_h
noti_ex_led_info_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_color_h color = NULL;

    ret = noti_ex_led_info_get_color(led_info, &color);
}
int noti_ex_led_info_get_off_period ( noti_ex_led_info_h  handle,
int *  ms 
)

Gets the time period for turning off the LED.

Since :
5.5
Parameters:
[in]handleThe notification_ex LED info handle
[out]msThe time for turning off the LED, in milliseconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_led_info_h
noti_ex_led_info_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int ms;

    ret = noti_ex_led_info_get_off_period(led_info, &ms);
}
int noti_ex_led_info_get_on_period ( noti_ex_led_info_h  handle,
int *  ms 
)

Gets the time period for turning on the LED.

Since :
5.5
Parameters:
[in]handleThe notification_ex LED info handle
[out]msThe time for turning on the LED, in milliseconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_led_info_h
noti_ex_led_info_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int ms;

    ret = noti_ex_led_info_get_on_period(led_info, &ms);
}

Sets the time period for turning off the LED.

Since :
5.5
Parameters:
[in]handleThe notification_ex LED info handle
[in]msThe time for turning off the LED, in milliseconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_led_info_h
noti_ex_led_info_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_led_info_set_off_period(led_info, 5);
}
int noti_ex_led_info_set_on_period ( noti_ex_led_info_h  handle,
int  ms 
)

Sets the time period for turning on the LED.

Since :
5.5
Parameters:
[in]handleThe notification_ex LED info handle
[in]msThe time for turning on the LED, in milliseconds
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_led_info_h
noti_ex_led_info_create()
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_led_info_set_on_period(led_info, 5);
}
int noti_ex_manager_create ( noti_ex_manager_h handle,
const char *  receiver_group,
noti_ex_manager_events_s  event_callbacks,
void *  user_data 
)

Creates the notification_ex manager handle.

Warning:
This is not for use by third-party applications.

The manager handle is created with event callbacks and the user can listen to notification events through the event callbacks. If the user wants to manage notifications for specific group the user should identify it with receiver_group Callbacks in event_callbacks can be set to NULL, which will result in the corresponding events not being received.

Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Remarks:
handle must be released using noti_ex_manager_destroy().
Parameters:
[out]handleThe notification manager handle
[in]receiver_groupThe notification group name of manager
[in]event_callbacksThe callbacks for notification events
[in]user_dataThe user data for event_callbacks
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYOut of memory
See also:
noti_ex_manager_h
noti_ex_manager_events_s
NOTI_EX_RECEIVER_GROUP_TICKER
NOTI_EX_RECEIVER_GROUP_LOCKSCREEN
NOTI_EX_RECEIVER_GROUP_INDICATOR
NOTI_EX_RECEIVER_GROUP_POPUP
noti_ex_manager_destroy()
Sample code:
#include <notification_ex.h>

void _manager_events_add_cb(noti_ex_manager_h handle, noti_ex_event_info_h info,
        noti_ex_item_h *added_item, int cnt, void *user_data) {
}

void _manager_events_update_cb(noti_ex_manager_h handle,
        noti_ex_event_info_h info, noti_ex_item_h updated_item, void *user_data) {
}

void _manager_events_delete_cb(noti_ex_manager_h handle,
        noti_ex_event_info_h info, noti_ex_item_h deleted_item, void *user_data) {
}

void _manager_events_error_cb(noti_ex_manager_h handle,
        noti_ex_error_e error, int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;

    ev.added = _manager_events_add_cb;
    ev.updated = _manager_events_update_cb;
    ev.deleted = _manager_events_delete_cb;
    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
}
int noti_ex_manager_delete ( noti_ex_manager_h  handle,
noti_ex_item_h  noti,
int *  request_id 
)

Deletes notification.

Warning:
This is not for use by third-party applications.
Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[in]notiThe notification item to be deleted
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_manager_h
noti_ex_error_e
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    noti_ex_item_h *items;
    noti_ex_item_h *item;
    int items_count;
    int request_id;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ret = noti_ex_manager_get(handle, &items, &items_count);
    for (int i = 0; i < items_count; i++) {
        item = items[i];
        noti_ex_manager_delete(handle, item, &request_id);
    }
}
int noti_ex_manager_delete_all ( noti_ex_manager_h  handle,
int *  request_id 
)

Deletes all notification.

Warning:
This is not for use by third-party applications.
Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_manager_h
noti_ex_error_e
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    noti_ex_item_h *items;
    noti_ex_item_h *item;
    int items_count;
    int request_id;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ret = noti_ex_manager_delete_all(handle, &request_id);
}

Destroys the notification_ex manager handle.

Since :
5.5
Parameters:
[in]handleThe notification manager handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_item_h
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ret = noti_ex_manager_destroy(handle);
}
int noti_ex_manager_find_by_root_id ( noti_ex_manager_h  handle,
const char *  root_id,
noti_ex_item_h item 
)

Finds notification by root id.

Warning:
This is not for use by third-party applications.
Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Remarks:
root_id is the id of the foremost notification item.
Parameters:
[in]handleThe notification manager handle
[in]root_idThe id of the foremost notification item to be retrieved
[out]itemThe result of the find operation
The item must be released using noti_ex_item_destroy().
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_manager_h
noti_ex_item_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    noti_ex_item_h item;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ret = noti_ex_manager_find_by_root_id(handle, "group1", &item);
}
int noti_ex_manager_get ( noti_ex_manager_h  handle,
noti_ex_item_h **  items,
int *  count 
)

Gets all notifications for the notification_ex manager.

Warning:
This is not for use by third-party applications.

Every notification that has been sent for the manager will be retrieved.

Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[out]itemsThe result of the get request
Each item in items must be released using noti_ex_item_destroy(), then items must be released using free().
[out]countThe count of retrieved notification items
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_item_h
noti_ex_manager_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    noti_ex_item_h *items;
    noti_ex_item_h *item;
    int items_count;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ret = noti_ex_manager_get(handle, &items, &items_count);
    for (int i = 0; i < items_count; i++) {
        item = items[i];
        // do something with item
        noti_ex_item_destroy(item);
    }

    free(items);
}
int noti_ex_manager_get_by_channel ( noti_ex_manager_h  handle,
char *  channel,
noti_ex_item_h **  items,
int *  count 
)

Gets notifications with channel for the notification_ex manager.

Warning:
This is not for use by third-party applications.

Every notification that has been sent for the manager will be retrieved.

Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[in]channelThe channel of a notification_ex item
[out]itemsThe result of the get request
Each item in items must be released using noti_ex_item_destroy(), then items must be released using free().
[out]countThe count of retrieved notification items
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_item_h
noti_ex_manager_h
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    noti_ex_item_h *items;
    noti_ex_item_h *item;
    int items_count;
    char *channel = "channel";

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ...
    ret = noti_ex_manager_get_by_channel(handle, channel, &items, &items_count);
    for (int i = 0; i < items_count; i++) {
        item = items[i];
        // do something with item
        noti_ex_item_destroy(item);
    }

    free(items);
}
int noti_ex_manager_get_notification_count ( noti_ex_manager_h  handle,
int *  count 
)

Gets the count of notifications for the manager.

Warning:
This is not for use by third-party applications.
Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[out]countThe count of notifications
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_manager_h
NOTI_EX_RECEIVER_GROUP_TICKER
NOTI_EX_RECEIVER_GROUP_LOCKSCREEN
NOTI_EX_RECEIVER_GROUP_INDICATOR
NOTI_EX_RECEIVER_GROUP_POPUP
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    int cnt;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ret = noti_ex_manager_get_notification_count(handle, &cnt);
}
int noti_ex_manager_hide ( noti_ex_manager_h  handle,
noti_ex_item_h  item,
int *  request_id 
)

Hides notification.

Warning:
This is not for use by third-party applications.
Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[in]itemThe notification item to be hidden
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_item_h
noti_ex_manager_h
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    noti_ex_item_h *items;
    noti_ex_item_h *item;
    int items_count;
    int request_id;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    for (int i = 0; i < items_count; i++) {
        item = items[i];
        ret = noti_ex_manager_hide(handle, item, &request_id);
    }
}

Sends error to the reporter.

Warning:
This is not for use by third-party applications.
Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[in]infoThe handle that contains event information
[in]errorThe error type
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_event_info_h
noti_ex_manager_h
noti_ex_error_e
Sample code:
#include <notification_ex.h>

void _manager_events_add_cb(noti_ex_manager_h handle, noti_ex_event_info_h info,
        noti_ex_item_h *added_item, int cnt, void *user_data) {
}

void _manager_events_update_cb(noti_ex_manager_h handle, noti_ex_event_info_h info,
        noti_ex_item_h updated_item, void *user_data) {
    // if something wrong about process
    noti_ex_manager_send_error(handle, info, NOTI_EX_ERROR_IO_ERROR);
}

void _manager_events_delete_cb(noti_ex_manager_h handle, noti_ex_event_info_h info,
        noti_ex_item_h deleted_item, void *user_data) {
}

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;

    ev.added = _manager_events_add_cb;
    ev.updated = _manager_events_update_cb;
    ev.deleted = _manager_events_delete_cb;
    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
}
int noti_ex_manager_update ( noti_ex_manager_h  handle,
noti_ex_item_h  item,
int *  request_id 
)

Updates notification.

Warning:
This is not for use by third-party applications.
Since :
5.5
Privilege Level:
partner
Privilege:
http://tizen.org/privilege/notification.admin
Parameters:
[in]handleThe notification manager handle
[in]itemThe notification item to be updated
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_item_h
noti_ex_manager_h
Sample code:
#include <notification_ex.h>

void _manager_events_error_cb(noti_ex_manager_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_manager_h handle;
    noti_ex_manager_events_s ev;
    noti_ex_item_h *items;
    noti_ex_item_h *item;
    int items_count;
    int request_id;

    ev.error = _manager_events_error_cb;
    ret = noti_ex_manager_create(&handle, NOTI_EX_RECEIVER_GROUP_INDICATOR, ev, NULL);
    ret = noti_ex_manager_get(handle, &items, &items_count);
    for (int i = 0; i < items_count; i++) {
        item = items[i];

        // modify item
        noti_ex_manager_update(handle, item, &request_id);
    }
}
int noti_ex_multi_lang_create ( noti_ex_multi_lang_h handle,
const char *  msgid,
const char *  format,
  ... 
)

Creates the multi-language item handle.

Since :
5.5
Remarks:
handle must be released using noti_ex_multi_lang_destroy().
Parameters:
[out]handleThe multi-language item handle
[in]msgidThe identifier of the message to be translated. One of the identifers declared in PO files.
The message of msgid and format must contain the same specifiers and in the same order.
[in]formatThe string that contains the text to be written.
It can optionally contain embedded format specifiers
that are replaced by the values specified in subsequent additional arguments and formatted as requested.
Valid specifiers are as follows.
d : Signed decimal integer
f : Decimal floating point
s : String of characters
[in]...The additional arguments. The values to be used to replace format specifiers in the format string.
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_multi_lang_h
noti_ex_multi_lang_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_multi_lang_h handle = NULL;

    // _IDS_TEST_ : "Hi %s version %f"
    ret = noti_ex_multi_lang_create(&handle, "_IDS_TEST_", "Hi %s version %f", "Tizen", 5.5);
    noti_ex_multi_lang_destroy(handle);
}

Destroys the multi-language item handle.

Since :
5.5
Parameters:
[in]handleThe multi-language item handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_multi_lang_h
noti_ex_multi_lang_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_multi_lang_h handle = NULL;

    // _IDS_TEST_ : "Hi %s version %f"
    ret = noti_ex_multi_lang_create(&handle, "_IDS_TEST_", "Hi %s version %f", "Tizen", 5.5);
    noti_ex_multi_lang_destroy(handle);
}
int noti_ex_padding_create ( noti_ex_padding_h handle,
int  left,
int  top,
int  right,
int  bottom 
)

Creates the notification_ex padding handle.

Padding information can be defined as a notification_ex padding handle with left, right, top and bottom values.

Since :
5.5
Remarks:
handle must be released using noti_ex_padding_destroy().
Parameters:
[out]handleThe notification_ex padding handle
[in]leftThe left value
[in]topThe top value
[in]rightThe right value
[in]bottomThe bottom value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_padding_h
noti_ex_padding_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_padding_h padding = NULL;

    ret = noti_ex_padding_create(&padding, 0, 0, 0, 0);
}

Releases a notification_ex padding handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex padding handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_padding_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_padding_destroy(padding);
}
int noti_ex_padding_get_bottom ( noti_ex_padding_h  handle,
int *  val 
)

Gets the bottom value of padding.

Since :
5.5
Parameters:
[in]handleThe notification_ex padding handle
[out]valThe bottom value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_padding_h
noti_ex_padding_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int bottom;

    ret = noti_ex_padding_get_bottom(padding, &bottom);
}
int noti_ex_padding_get_left ( noti_ex_padding_h  handle,
int *  val 
)

Gets the left value of padding.

Since :
5.5
Parameters:
[in]handleThe notification_ex padding handle
[out]valThe left value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_padding_h
noti_ex_padding_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int left;

    ret = noti_ex_padding_get_left(padding, &left);
}
int noti_ex_padding_get_right ( noti_ex_padding_h  handle,
int *  val 
)

Gets the right value of padding.

Since :
5.5
Parameters:
[in]handleThe notification_ex padding handle
[out]valThe right value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_padding_h
noti_ex_padding_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int right;

    ret = noti_ex_padding_get_right(padding, &right);
}
int noti_ex_padding_get_top ( noti_ex_padding_h  handle,
int *  val 
)

Gets the top value of padding.

Since :
5.5
Parameters:
[in]handleThe notification_ex padding handle
[out]valThe top value
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_padding_h
noti_ex_padding_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    int top;

    ret = noti_ex_padding_get_top(padding, &top);
}
int noti_ex_reporter_create ( noti_ex_reporter_h handle,
noti_ex_reporter_events_s  event_callbacks,
void *  user_data 
)

Creates the notification_ex reporter handle.

The reporter handle is created with event callbacks and the user can listen notification events through the event callbacks. Callbacks in event_callbacks can be set to NULL, which will result in the corresponding events not being received.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Remarks:
handle must be released using noti_ex_reporter_destroy().
Parameters:
[out]handleThe notification reporter handle
[in]event_callbacksThe callbacks for notification events
[in]user_dataThe user data for event_callbacks
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYOut of memory
See also:
noti_ex_item_h
noti_ex_reporter_events_s
noti_ex_reporter_destroy()
Sample code:
#include <notification_ex.h>

void _reporter_events_event_cb(noti_ex_reporter_h handle, noti_ex_event_info_h info,
        noti_ex_item_h *items, int cnt, void *user_data) {
}

void _reporter_events_error_cb(noti_ex_reporter_h handle,
        noti_ex_error_e error, int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;

    ev.event = _reporter_events_event_cb;
    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
}
int noti_ex_reporter_delete ( noti_ex_reporter_h  handle,
noti_ex_item_h  noti,
int *  request_id 
)

Deletes a notification.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Parameters:
[in]handleThe notification reporter handle
[in]notiThe notification handle to be updated
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_reporter_create()
Sample code:
#include <notification_ex.h>

void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;
    int request_id;

    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
    ret = noti_ex_reporter_find_by_root_id(handle, "group_id", &group_item);
    ret = noti_ex_reporter_delete(handle, group_item, &request_id);
}
int noti_ex_reporter_delete_all ( noti_ex_reporter_h  handle,
int *  request_id 
)

Deletes all notifications.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Parameters:
[in]handleThe notification reporter handle
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_reporter_create()
Sample code:
#include <notification_ex.h>

void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;
    int request_id;

    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
    ret = noti_ex_reporter_delete_all(handle, &request_id);
}

Destroys the notification_ex reporter handle.

Since :
5.5
Parameters:
[in]handleThe notification reporter handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_reporter_create()
Sample code:
#include <notification_ex.h>

void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;

    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
    ret = noti_ex_reporter_destroy(handle);
}
int noti_ex_reporter_find_by_root_id ( noti_ex_reporter_h  handle,
const char *  root_id,
noti_ex_item_h item 
)

Finds notification by root id.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Parameters:
[in]handleThe notification reporter handle
[in]root_idThe id of the foremost notification item to be retrieved
[out]itemThe result of the find operation
The item must be released using noti_ex_item_destroy().
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_reporter_create()
noti_ex_item_destroy()
Sample code:
#include <notification_ex.h>

void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;
    int request_id;

    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
    ret = noti_ex_reporter_find_by_root_id(handle, "group_id", &group_item);
    ret = noti_ex_reporter_delete(handle, group_item, &request_id);
}
int noti_ex_reporter_post ( noti_ex_reporter_h  handle,
noti_ex_item_h  noti,
int *  request_id 
)

Posts a notification.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Parameters:
[in]handleThe notification reporter handle
[in]notiThe notification handle to be posted
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_reporter_create()
Sample code:
#include <notification_ex.h>

void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;
    int request_id;

    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
    ret = noti_ex_item_group_create(&group_item, "group_id");
    ret = noti_ex_item_button_create(&child_item, "button_id", "button_title");
    ret = noti_ex_item_group_add_child(group_item, child_item);
    noti_ex_item_destroy(child_item);

    ret = noti_ex_reporter_post(handle, group_item, &request_id);
    noti_ex_item_destroy(group_item);
}
int noti_ex_reporter_post_list ( noti_ex_reporter_h  handle,
noti_ex_item_h noti_list,
int  count,
int *  request_id 
)

Posts notifications contained in a list.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Parameters:
[in]handleThe notification reporter handle
[in]noti_listThe notification handle list to be posted
[in]countThe count of notifications in noti_list
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_reporter_create()
Sample code:
#include <notification_ex.h>

void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;
    noti_ex_item_h *noti_list = (noti_ex_item_h *)calloc(2, sizeof(noti_ex_item_h));
    int request_id;

    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
    ret = noti_ex_item_group_create(&noti_list[0], "group_id1");
    ret = noti_ex_item_button_create(&child_item, "button_id1", "button_title");
    ret = noti_ex_item_group_add_child(noti_list[0], child_item);
    noti_ex_item_destroy(child_item);

    ret = noti_ex_item_group_create(&noti_list[1], "group_id2");
    ret = noti_ex_item_button_create(&child_item, "button_id2", "button_title");
    ret = noti_ex_item_group_add_child(noti_list[1], child_item);
    noti_ex_item_destroy(child_item);

    ret = noti_ex_reporter_post_list(handle, noti_list, 2, &request_id);
    noti_ex_item_destroy(noti_list[0]);
    noti_ex_item_destroy(noti_list[1]);

    free(noti_list);
}

Sends error to the manager.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Parameters:
[out]handleThe notification reporter handle
[in]infoThe handle that contains event information
[in]errorThe error type
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_event_info_h
noti_ex_manager_events_s
noti_ex_error_e
Sample code:
#include <notification_ex.h>

void _reporter_events_event_cb(noti_ex_reporter_h handle, noti_ex_event_info_h info,
        noti_ex_item_h *items, int cnt, void *user_data) {

    // if something wrong about process
    noti_ex_reporter_send_error(handle, info, NOTI_EX_ERROR_IO_ERROR);
}

void _reporter_events_error_cb(noti_ex_reporter_h handle,
        noti_ex_error_e error, int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;

    ev.event = _reporter_events_event_cb;
    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
}
int noti_ex_reporter_update ( noti_ex_reporter_h  handle,
noti_ex_item_h  noti,
int *  request_id 
)

Updates a notification.

Since :
5.5
Privilege Level:
public
Privilege:
http://tizen.org/privilege/notification
Parameters:
[in]handleThe notification reporter handle
[in]notiThe notification handle to be updated
[out]request_idThe id of request
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_PERMISSION_DENIEDPermission deny
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_IO_ERRORIO error
See also:
noti_ex_reporter_create()
Sample code:
#include <notification_ex.h>

void _reporter_events_error_cb(noti_ex_reporter_h handle, noti_ex_error_e error,
        int req_id, void *user_data) {
}

{
    int ret;
    noti_ex_reporter_h handle;
    noti_ex_reporter_events_s ev;
    noti_ex_item_h group_item = NULL;
    noti_ex_item_h child_item = NULL;
    int request_id;

    ev.error = _reporter_events_error_cb;
    ret = noti_ex_reporter_create(&handle, ev, NULL);
    ret = noti_ex_reporter_find_by_root_id(handle, "group_id", &group_item);
    ret = noti_ex_item_group_set_direction(group_item, false);
    ret = noti_ex_reporter_update(handle, group_item, &request_id);
}
int noti_ex_style_create ( noti_ex_style_h handle,
noti_ex_color_h  color,
noti_ex_padding_h  padding,
noti_ex_geometry_h  geometry 
)

Creates the notification_ex style handle.

Style information can be defined as a notification_ex style handle with color, padding and geometry information. The color is the defined notification_ex color handle. The padding is the defined notification_ex padding handle. The geometry is the defined notification_ex geometry handle.

Since :
5.5
Remarks:
handle must be released using noti_ex_style_destroy(). color, padding and geometry must not be released if the function returns NOTI_EX_ERROR_NONE. color, padding and geometry will be released when handle is released.
Parameters:
[out]handleThe notification_ex padding handle
[in]colorThe notification_ex color handle
[in]paddingThe notification_ex padding handle
[in]geometryThe notification_ex geometry handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
NOTI_EX_ERROR_OUT_OF_MEMORYout of memory
See also:
noti_ex_style_h
noti_ex_color_h
noti_ex_padding_h
noti_ex_geometry_h
noti_ex_style_destroy()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_style_h style = NULL;
    noti_ex_color_h color = NULL;
    noti_ex_padding_h padding = NULL;
    noti_ex_geometry_h geometry = NULL;

    ret = noti_ex_color_create(&color, 0, 0, 0, 0);
    ret = noti_ex_padding_create(&padding, 0, 0, 0, 0);
    ret = noti_ex_geometry_create(&geometry, 0, 0, 0, 0);

    ret = noti_ex_style_create(&style, color, padding, geometry);
}

Releases the notification_ex style handle.

Since :
5.5
Parameters:
[in]handleThe notification_ex style handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
Sample code:
#include <notification_ex.h>

{
    int ret;

    ret = noti_ex_style_destroy(style);
}

Gets the background color of a style.

Since :
5.5
Remarks:
color must be released using noti_ex_color_destroy().
Parameters:
[in]handleThe notification_ex style handle
[out]colorThe notification_ex color handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_color_h color = NULL;

    ret = noti_ex_style_get_background_color(style, &color);
}
int noti_ex_style_get_background_image ( noti_ex_style_h  handle,
char **  image_path 
)

Gets the background image path from style.

Since :
5.5
Remarks:
The image_path should be released using free().
Parameters:
[in]handleThe notification_ex style handle
[out]image_pathThe background image path
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *image_path;

    ret = noti_ex_style_get_background_image(style, &image_path);
}

Gets the color information from a style.

Since :
5.5
Remarks:
color must be released using noti_ex_color_destroy().
Parameters:
[in]handleThe notification_ex style handle
[out]colorThe notification_ex color handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
noti_ex_color_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_color_h color = NULL;

    ret = noti_ex_style_get_color(style, &color);
}

Gets the geometry information from style.

Since :
5.5
Remarks:
geometry must be released using noti_ex_geometry_destroy().
Parameters:
[in]handleThe notification_ex style handle
[out]geometryThe notification_ex geometry handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
noti_ex_geometry_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_geometry_h geometry = NULL;

    ret = noti_ex_style_get_geometry(style, &geometry);
}

Gets the padding information from a style.

Since :
5.5
Remarks:
padding must be released using noti_ex_padding_destroy().
Parameters:
[in]handleThe notification_ex style handle
[out]paddingThe notification_ex padding handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
noti_ex_padding_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_padding_h padding = NULL;

    ret = noti_ex_style_get_padding(style, &padding);
}

Sets the background color of a style.

Since :
5.5
Remarks:
color must be released using noti_ex_color_destroy().
Parameters:
[in]handleThe notification_ex style handle
[in]colorThe notification_ex color handle
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    noti_ex_color_h color;

    ret = noti_ex_color_create(&color, 0, 0, 0, 0);
    ret = noti_ex_style_set_background_color(style, color);
    ret = noti_ex_color_destroy(color);
}
int noti_ex_style_set_background_image ( noti_ex_style_h  handle,
char *  image_path 
)

Sets the background image path of a style.

Since :
5.5
Parameters:
[in]handleThe notification_ex style handle
[in]image_pathThe background image path
Returns:
NOTI_EX_ERROR_NONE On success, other value on failure
Return values:
NOTI_EX_ERROR_NONESuccess
NOTI_EX_ERROR_INVALID_PARAMETERInvalid parameter
See also:
noti_ex_style_h
noti_ex_style_create()
Sample code:
#include <notification_ex.h>

{
    int ret;
    char *image_path[BUFLEN];

    char *shared_path = app_get_shared_resource_path();
    snprintf(image_path, BUFLEN, "%simage.png", shared_path);
    free(shared_path);

    ret = noti_ex_style_set_background_image(style, image_path);
}