#define NOTIFICATION_VARIABLE_TYPE_MAX NOTIFICATION_VARIABLE_TYPE_COUNT
/**
- * @brief Enumeration for notification ongoing value type.
+ * @brief Enumeration for notification resource path type.
* @since_tizen 3.0
*/
typedef enum _notification_res_path_type {
- NOTIFICATION_RES_PATH_TYPE_SOUND = NOTIFICATION_IMAGE_TYPE_MAX + 1,
- NOTIFICATION_RES_PATH_TYPE_VIBRATION,
+ NOTIFICATION_RES_PATH_TYPE_SOUND = NOTIFICATION_IMAGE_TYPE_MAX + 1, /**< Sound */
+ NOTIFICATION_RES_PATH_TYPE_VIBRATION, /**< Vibration */
} notification_res_path_type_e;
/**
* @since_tizen 3.0
*/
typedef enum _notification_ongoing_value_type {
- NOTIFICATION_ONGOING_VALUE_TYPE_PERCENT = 0,
- NOTIFICATION_ONGOING_VALUE_TYPE_TIME,
+ NOTIFICATION_ONGOING_VALUE_TYPE_PERCENT = 0, /**< Percent */
+ NOTIFICATION_ONGOING_VALUE_TYPE_TIME, /**< Time */
} notification_ongoing_value_type_e;
/**
* @see #notification_event_type_e
*/
typedef enum _notification_event_type_extension {
- NOTIFICATION_EVENT_TYPE_HIDDEN_BY_USER = 100,
- NOTIFICATION_EVENT_TYPE_HIDDEN_BY_TIMEOUT = 101,
- NOTIFICATION_EVENT_TYPE_HIDDEN_BY_EXTERNAL = 102,
- NOTIFICATION_EVENT_TYPE_PRESSED = 200,
- NOTIFICATION_EVENT_TYPE_DELETED = 201,
+ NOTIFICATION_EVENT_TYPE_HIDDEN_BY_USER = 100, /**< Hidden by user */
+ NOTIFICATION_EVENT_TYPE_HIDDEN_BY_TIMEOUT = 101, /**< Hidden by timeout */
+ NOTIFICATION_EVENT_TYPE_HIDDEN_BY_EXTERNAL = 102, /**< Hidden by external */
+ NOTIFICATION_EVENT_TYPE_PRESSED = 200, /**< Pressed by user */
+ NOTIFICATION_EVENT_TYPE_DELETED = 201, /**< Deleted by user */
} notification_event_type_extension_e;
GQuark notification_error_quark(void);
/**
- * @brief This function add deferred task. the registered task will be executed when notification service become ready
+ * @brief This function add deferred task. The registered task will be executed when notification service become ready.
* @param[in] deferred_task_cb The callback function
* @param[in] user_data The user data to be passed to the callback function
* @return #NOTIFICATION_ERROR_NONE if success, other value if failure
/**
* @brief Updates the progress of the inserted notification. This only works for the ongoing notification (NOTIFICATION_TYPE_ONGOING).
* @details The Notification view on the notification area could be updated.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] noti Notification handle or NULL if priv_id is valid
* @param[in] priv_id Private ID
* @param[in] progress Percentage value of progressive data
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
-#include <notification.h>
+#include <notification_internal.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
/**
* @brief Updates the size of inserted notification data. This only works for the ongoing notification (NOTIFICATION_TYPE_ONGOING).
* @details Notification view on notification area could be updated.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] noti Notification handle or NULL if priv_id is valid
* @param[in] priv_id Private ID
* @param[in] size Bytes of progressive data
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
-#include <notification.h>
+#include <notification_internal.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
/**
* @brief Updates the content of the inserted notification data. This is only for the ongoing notification (NOTIFICATION_TYPE_ONGOING).
* @details Notification view on notification area could be updated.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @param[in] noti Notification handle or NULL if priv_id is valid
* @param[in] priv_id Private ID
* @param[in] content Text to update
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
-#include <notification.h>
+#include <notification_internal.h>
...
{
int noti_err = NOTIFICATION_ERROR_NONE;
/**
* @internal
- * @brief
- * @details Gets the numbers of all notifications
+ * @brief Gets the numbers of all notifications.
* @since tizen 4.0
- * @param[int] type the type of notification
- * @param[out] count the numbers of all notifications
+ * @param[in] type The type of notification
+ * @param[out] count The numbers of all notifications
* @return NOTIFICATION_ERROR_NONE on success, other value on failure
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
/**
* @internal
+ * @brief Sets caller's app_id.
* @details caller_app_id is set automatically when notification_create() is called. We do not recommend to use this API.
+ * @since_tizen 4.0
* @param[in] noti Notification handle
* @param[in] app_id Caller application id
* @return NOTIFICATION_ERROR_NONE on success, other value on failure
/**
* @internal
- * @brief Set priv_id of the notification.
+ * @brief Sets priv_id of the notification.
+ * @since_tizen 4.0
* @param[in] noti Notification handle
* @param[in] priv_id Private ID
* @return NOTIFICATION_ERROR_NONE on success, other value on failure
}
* @endcode
*/
-int notification_insert(notification_h noti,
- int *priv_id);
-
-int notification_insert_for_uid(notification_h noti,
- int *priv_id, uid_t uid);
+int notification_insert(notification_h noti, int *priv_id);
+int notification_insert_for_uid(notification_h noti, int *priv_id, uid_t uid);
/**
* @internal
/**
* @brief Gets the notification ongoing value type.
* @since_tizen 3.0
- * @param[in] noti The notification handle
- * @param[out] type The notification ongoing value type
+ * @param[in] noti The notification handle
+ * @param[out] type The notification ongoing value type
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
int notification_set_ongoing_value_type(notification_h noti, notification_ongoing_value_type_e type);
/**
- * @brief Gets the notification ongoing time when ongoint type value is set NOTIFICATION_ONGOING_VALUE_TYPE_TIME.
+ * @brief Gets the notification ongoing time when ongoint type value is set #NOTIFICATION_ONGOING_VALUE_TYPE_TIME.
* @since_tizen 3.0
* @param[in] noti The notification handle
* @param[out] current The ongoing current time
int notification_get_ongoing_time(notification_h noti, int *current, int *duration);
/**
- * @brief Sets the notification ongoing time when ongoint type value is set NOTIFICATION_ONGOING_VALUE_TYPE_TIME.
+ * @brief Sets the notification ongoing time when ongoint type value is set #NOTIFICATION_ONGOING_VALUE_TYPE_TIME.
* @since_tizen 3.0
* @param[in] noti The notification handle
* @param[in] current The ongoing current time
int notification_check_event_receiver_available(notification_h noti, bool *available);
/**
- * @brief This function translate localized texts
+ * @brief This function translate localized texts.
+ * @since_tizen 3.0
* @param[in] noti The notification handle that is created by notification_create()
* @return #NOTIFICATION_ERROR_NONE if success, other value if failure
* @see notification_create()
/**
* @brief Gets a max length of text input.
* @since_tizen 3.0
+ * @param[in] noti The notification handle
+ * @param[in] Max length of Text input
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @internal
* @brief Sets the label of caller application.
* @details It recommends for daemons. For an Application, the label is set when notification create.
- * @since tizen 5.0
+ * @since_tizen 5.0
* @param[in] noti Notification handle
* @param[in] label Label of Caller application
* @return NOTIFICATION_ERROR_NONE on success, other value on failure
/**
* @internal
- * @brief Gets the label of caller application
+ * @brief Gets the label of caller application.
* @details Label may be null if it was not set.
- * Do not free @a label. It will be freed when notification_free() is called.
- * @since tizen 5.0
+ * Do not free @a label. It will be freed when notification_free() is called.
+ * @since_tizen 5.0
* @param[in] noti Notification handle
* @param[out] label Label of Caller application
* @return NOTIFICATION_ERROR_NONE on success, other value on failure
typedef struct notification_system_setting *notification_system_setting_h;
typedef struct notification_system_setting_dnd_allow_exception *dnd_allow_exception_h;
-/*
- * The prototype of handler that 'Do not disturb' mode set schdule changed alarm.
+/**
+ * @brief The prototype of handler that 'Do not disturb' mode set schdule changed alarm.
+ * @since_tizen 3.0
*/
typedef void (*dnd_changed_cb)(void *user_data, int do_not_disturb);
/**
-* @brief Enumeration for Week Flag, the days of the week.
-* @since_tizen 3.0
-*/
+ * @brief Enumeration for Week Flag, the days of the week.
+ * @since_tizen 3.0
+ */
typedef enum {
DND_SCHEDULE_WEEK_FLAG_SUNDAY = 0x01, /**< Sunday */
DND_SCHEDULE_WEEK_FLAG_MONDAY = 0x02, /**< Monday */
DND_SCHEDULE_WEEK_FLAG_THURSDAY = 0x10, /**< Thursday */
DND_SCHEDULE_WEEK_FLAG_FRIDAY = 0x20, /**< Friday */
DND_SCHEDULE_WEEK_FLAG_SATURDAY = 0x40, /**< Saturday */
- DND_SCHEDULE_WEEK_FLAG_MAX = 0x80,
DND_SCHEDULE_WEEK_FLAG_ALL = DND_SCHEDULE_WEEK_FLAG_SUNDAY|
DND_SCHEDULE_WEEK_FLAG_MONDAY |
DND_SCHEDULE_WEEK_FLAG_TUESDAY |
} dnd_schedule_week_flag_e;
/**
-* @brief Enumeration for lock screen content.
-* @since_tizen 3.0
-*/
+ * @brief Enumeration for lock screen content.
+ * @since_tizen 3.0
+ */
typedef enum lock_screen_content_level {
- SHOW_ALL_CONTENT = 0,
- HIDE_SENSITIVE_CONTENT,
- DO_NOT_SHOW_NOTIFICATIONS,
+ SHOW_ALL_CONTENT = 0, /**< Show all*/
+ HIDE_SENSITIVE_CONTENT, /**< Hide sensitive */
+ DO_NOT_SHOW_NOTIFICATIONS, /**< Do not Showw */
} lock_screen_content_level_e;
/**
* @since_tizen 3.0
*/
typedef enum dnd_allow_exception_type {
- NOTIFICATION_DND_ALLOWED_CALLS = 0,
+ NOTIFICATION_DND_ALLOWED_CALLS = 0, /**< Call */
/* possible to add */
} dnd_allow_exception_type_e;
* @since_tizen 3.0
*/
typedef enum notification_dnd_allowed_calls {
- NOTIFICATION_DND_ALLOWED_CALLS_EVERYONE = 0,
- NOTIFICATION_DND_ALLOWED_CALLS_CONTACT,
- NOTIFICATION_DND_ALLOWED_CALLS_FAVORITE,
- NOTIFICATION_DND_ALLOWED_CALLS_NOBODY,
+ NOTIFICATION_DND_ALLOWED_CALLS_EVERYONE = 0, /**< Everyone */
+ NOTIFICATION_DND_ALLOWED_CALLS_CONTACT, /**< Contact */
+ NOTIFICATION_DND_ALLOWED_CALLS_FAVORITE, /**< Favorite */
+ NOTIFICATION_DND_ALLOWED_CALLS_NOBODY, /**< Nobody */
} notification_dnd_allowed_calls_e;
/* Application setting */
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[out] setting_array The array of otification setting
- * @param[out] count The count of array
+ * @param[out] setting_array The array of notification setting
+ * @param[out] count The count of array
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
int notification_setting_get_setting_array(notification_setting_h *setting_array, int *count);
int notification_setting_get_setting_array_for_uid(notification_setting_h *setting_array, int *count, uid_t uid);
-/*
+/**
* @internal
* @brief Gets notification setting by package name.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] package_name The package_name
- * @param[out] setting The notification setting
+ * @param[in] package_name The package_name
+ * @param[out] setting The notification setting
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
int notification_setting_get_setting_by_package_name(const char *package_name, notification_setting_h *setting);
int notification_setting_get_setting_by_appid_for_uid(const char *app_id, notification_setting_h *setting, uid_t uid);
-/*
+/**
* @internal
* @brief Gets package name from notification setting handle.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification setting handle
- * @param[out] value The package name
+ * @param[in] setting The notification setting handle
+ * @param[out] value The package name
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_get_package_name(notification_setting_h setting, char **value);
-/*
+/**
* @internal
* @brief Gets application id from notification setting handle.
* @since_tizen 3.0
- * @param[in] setting The notification setting handle
- * @param[out] app_id The application id
+ * @param[in] setting The notification setting handle
+ * @param[out] app_id The application id
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_get_appid(notification_setting_h setting, char **app_id);
-/*
+/**
* @internal
* @brief Gets value which whether allow notification from individual applications.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification setting handle
- * @param[out] value The value which whether allow to notification
+ * @param[in] setting The notification setting handle
+ * @param[out] value The value which whether allow to notification
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_get_allow_to_notify(notification_setting_h setting, bool *value);
-/*
+/**
* @internal
* @brief Sets value which whether allow notification from individual applications.
* @details After notification_setting_update_setting() call, the allow_to_notify is updated.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification setting handle
- * @param[in] value The value whether allow to notification
+ * @param[in] setting The notification setting handle
+ * @param[in] value The value whether allow to notification
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_set_allow_to_notify(notification_setting_h setting, bool value);
-/*
+/**
* @internal
* @brief Gets value which whether do not disturb notification from notification setting handle.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification setting handle
- * @param[out] value The value which whether do not disturb notification or not
- *
+ * @param[in] setting The notification setting handle
+ * @param[out] value The value which whether do not disturb notification or not
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_get_do_not_disturb_except(notification_setting_h setting, bool *value);
-/*
+/**
* @internal
* @brief Sets value which whether do not disturb notification or not.
* @details After notification_setting_update_setting() call, the do_not_disturb value is updated.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification setting handle
- * @param[in] value The value which do not disturb notification or not
+ * @param[in] setting The notification setting handle
+ * @param[in] value The value which do not disturb notification or not
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_set_do_not_disturb_except(notification_setting_h setting, bool value);
-/*
+/**
* @internal
* @brief Gets value whether Pop up notification is allowed or not.
* @since_tizen 3.0
- * @param[in] setting The notification setting handle
- * @param[in] value The value
+ * @param[in] setting The notification setting handle
+ * @param[in] value The value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_get_pop_up_notification(notification_setting_h setting, bool *value);
-/*
+/**
* @internal
* @brief Sets value which Pop up notification allow or block.
* @details After notification_setting_update_setting() call, the pop_up_notification value is updated.
* @since_tizen 3.0
- * @param[in] setting The notification setting handle
- * @param[in] value The value
+ * @param[in] setting The notification setting handle
+ * @param[in] value The value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_set_pop_up_notification(notification_setting_h setting, bool value);
-/*
+/**
* @internal
* @brief Gets displaying level that notification's information on lock screen from individual application.
* @since_tizen 3.0
- * @param[in] setting The notification setting handle
- * @param[out] level The displaying level of notification's information on lock screen
+ * @param[in] setting The notification setting handle
+ * @param[out] level The displaying level of notification's information on lock screen
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_get_lock_screen_content(notification_setting_h setting, lock_screen_content_level_e *level);
-/*
+/**
* @internal
* @brief Sets displaying level that notification's information on lock screen from individual application.
* @details After notification_setting_update_setting() call, the lock_screen_content_level value is updated.
* @since_tizen 3.0
- * @param[in] setting The notification setting handle
- * @param[out] level The displaying level of notification's information on lock screen
+ * @param[in] setting The notification setting handle
+ * @param[out] level The displaying level of notification's information on lock screen
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_set_lock_screen_content(notification_setting_h setting, lock_screen_content_level_e level);
-/*
+/**
* @internal
- * @brief Gets The value that determines whether the app is disabled
+ * @brief Gets The value that determines whether the app is disabled.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] setting The notification system setting handle
- * @param[out] value The value that determines whether the app is disabled
+ * @param[in] setting The notification system setting handle
+ * @param[out] value The value that determines whether the app is disabled
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_setting_get_app_disabled(notification_setting_h setting, bool *value);
-/*
+/**
* @internal
* @brief Gets the notification system setting handle.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] setting The notification system setting handle
+ * @param[in] system_setting The notification system setting handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NOTIFICATION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #NOTIFICATION_ERROR_IO_ERROR I/O error
+ * @retval #NOTIFICATION_ERROR_SERVICE_NOT_READY No response from notification service
+ * @retval #NOTIFICATION_ERROR_PERMISSION_DENIED Permission denied
* @par sample code:
* @code
#include <notification_setting_internal.h>
int notification_system_setting_load_system_setting(notification_system_setting_h *system_setting);
int notification_system_setting_load_system_setting_for_uid(notification_system_setting_h *system_setting, uid_t uid);
-/*
+/**
* @internal
- * @brief Update the notification system handle.
+ * @brief Updates the notification system handle.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] setting The notification system setting handle
+ * @param[in] system_setting The notification system setting handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
int notification_system_setting_update_system_setting(notification_system_setting_h system_setting);
int notification_system_setting_update_system_setting_for_uid(notification_system_setting_h system_setting, uid_t uid);
-/*
+/**
* @internal
* @brief Frees the internal structure data of a notification system setting handle.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification system setting handle
+ * @param[in] system_setting The notification system setting handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_free_system_setting(notification_system_setting_h system_setting);
-/*
+/**
* @internal
* @brief Gets value which whether do not disturb notification from notification system setting handle.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification system setting handle
- * @param[out] value The value which whether do not disturb notification or not
- *
+ * @param[in] system_setting The notification system setting handle
+ * @param[out] value The value which whether do not disturb notification or not
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_get_do_not_disturb(notification_system_setting_h system_setting, bool *value);
-/*
+/**
* @internal
* @brief Sets value which whether do not disturb notification or not.
* @details After notification_system_setting_update_system_setting() call, the do_not_disturb value is not updated.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification system setting handle
- * @param[in] value The value which do not disturb notification or not
- *
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] value The value which do not disturb notification or not
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_set_do_not_disturb(notification_system_setting_h system_setting, bool value);
-/*
+/**
* @internal
* @brief Gets value which whether information on the notification view is visible.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification system setting handle
- * @param[out] value The visibility_class value
+ * @param[in] system_setting The notification system setting handle
+ * @param[out] value The visibility_class value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_get_visibility_class(notification_system_setting_h system_setting, int *value);
-/*
+/**
* @internal
* @brief Sets value which whether information on the notification view is visible.
* @details After notification_system_setting_update_system_setting() call, the visibility_class value is not updated.
* @since_tizen @if wearable 2.3.1 @elseif mobile 2.3 @endif
- * @param[in] setting The notification setting handle
- * @param[in] value The visibility_class value
+ * @param[in] system_setting The notification setting handle
+ * @param[in] value The visibility_class value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_set_visibility_class(notification_system_setting_h system_setting, int value);
-/*
+/**
* @internal
* @brief Gets value which whether 'Do not disturb' mode is enable or not.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[out] enabled The dnd_schedule_enabled value
+ * @param[in] system_setting The notification system setting handle
+ * @param[out] enabled The dnd_schedule_enabled value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_get_enabled(notification_system_setting_h system_setting, bool *enabled);
-/*
+/**
* @internal
* @brief Sets value which whether 'Do not disturb' mode is enable or not.
* @details After notification_system_setting_update_system_setting() call, the 'Do not disturb' mode is not updated.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[in] enabled The dnd_schedule_enabled value
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] enabled The dnd_schedule_enabled value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_set_enabled(notification_system_setting_h system_setting, bool enabled);
-/*
+/**
* @internal
* @brief Gets days of the week that 'Do not disturb' mode is enable.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[out] day The days of the week that enable 'Do not disturb' mode
+ * @param[in] system_setting The notification system setting handle
+ * @param[out] day The days of the week that enable 'Do not disturb' mode
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_get_day(notification_system_setting_h system_setting, int *day);
-/*
+/**
* @internal
* @brief Sets days of the week that 'Do not disturb' mode is enable.
* @details After notification_system_setting_update_system_setting() call, the days not updated.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[in] day The days of the week that enable 'Do not disturb' mode
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] day The days of the week that enable 'Do not disturb' mode
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_set_day(notification_system_setting_h system_setting, int day);
-/*
+/**
* @internal
* @brief Gets time that 'Do not disturb' mode is started.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[out] hour The hour that 'Do not disturb' mode is started
- * @param[out] min The min that 'Do not disturb' mode is started
+ * @param[in] system_setting The notification system setting handle
+ * @param[out] hour The hour that 'Do not disturb' mode is started
+ * @param[out] min The min that 'Do not disturb' mode is started
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_get_start_time(notification_system_setting_h system_setting, int *hour, int *min);
-/*
+/**
* @internal
* @brief Sets time that 'Do not disturb' mode is started.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[in] hour The hour that 'Do not disturb' mode is startd
- * @param[in] min The min that 'Do not disturb' mode is started
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] hour The hour that 'Do not disturb' mode is startd
+ * @param[in] min The min that 'Do not disturb' mode is started
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_set_start_time(notification_system_setting_h system_setting, int hour, int min);
-/*
+/**
* @internal
* @brief Gets time that 'Do not disturb' mode is ended.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[out] hour The hour that 'Do not disturb' mode is ended
- * @param[out] min The min that 'Do not disturb' mode is ended
+ * @param[in] system_setting The notification system setting handle
+ * @param[out] hour The hour that 'Do not disturb' mode is ended
+ * @param[out] min The min that 'Do not disturb' mode is ended
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_get_end_time(notification_system_setting_h system_setting, int *hour, int *min);
-/*
+/**
* @internal
* @brief Sets time that 'Do not disturb' mode is ended.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[in] hour The hour that 'Do not disturb' mode is ended
- * @param[in] min The min that 'Do not disturb' mode is ended
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] hour The hour that 'Do not disturb' mode is ended
+ * @param[in] min The min that 'Do not disturb' mode is ended
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_dnd_schedule_set_end_time(notification_system_setting_h system_setting, int hour, int min);
-/*
+/**
* @internal
* @brief Gets displaying level that notification's information on lock screen.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[out] level The displaying level of notification's information on lock screen
+ * @param[in] system_setting The notification system setting handle
+ * @param[out] level The displaying level of notification's information on lock screen
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @internal
* @brief Sets displaying level that notification's information on lock screen.
* @since_tizen 3.0
- * @param[in] setting The notification system setting handle
- * @param[in] level The displaying level of notification's information on lock screen
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] level The displaying level of notification's information on lock screen
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
*/
int notification_system_setting_set_lock_screen_content(notification_system_setting_h system_setting, lock_screen_content_level_e level);
-/*
+/**
* @internal
* @brief Gets a value of the do_not_disturb allow exceptions.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] setting The notification system setting handle
- * @param[in] dnd_allow_exception_type_e The exceptional item of do_not_distrub
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] type The exceptional item of do_not_distrub
* @param[out] value The value of the exceptional item
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
*/
int notification_system_setting_get_dnd_allow_exceptions(notification_system_setting_h system_setting, dnd_allow_exception_type_e type, int *value);
-/*
+/**
* @internal
* @brief Sets a value of the do_not_disturb allow exceptions.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] setting The notification system setting handle
- * @param[in] dnd_allow_exception_type_e The exceptional item of do_not_distrub
+ * @param[in] system_setting The notification system setting handle
+ * @param[in] type The exceptional item of do_not_distrub
* @param[in] value The value of the exceptional item
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
*/
int notification_system_setting_set_dnd_allow_exceptions(notification_system_setting_h system_setting, dnd_allow_exception_type_e type, int value);
-/*
+/**
* @internal
* @brief Registers a callback for turn on/off 'Do not disturb' mode by user_data
* or 'Do not disturb' mode setting schedule is start or end.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] callback The callback function
- * @param[in] user_data The user data
+ * @param[in] callback The callback function
+ * @param[in] user_data The user data
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
int notification_register_system_setting_dnd_changed_cb(dnd_changed_cb callback, void *user_data);
int notification_register_system_setting_dnd_changed_cb_for_uid(dnd_changed_cb callback, void *user_data, uid_t uid);
-/*
+/**
* @internal
* @brief Unregisters a callback for turn on/off 'Do not disturb' mode by user_data
* or 'Do not disturb' mode setting schedule is start or end.
* @since_tizen 3.0
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
- * @param[in] callback The callback function
+ * @param[in] callback The callback function
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
int notification_unregister_system_setting_dnd_changed_cb(dnd_changed_cb callback);
int notification_unregister_system_setting_dnd_changed_cb_for_uid(dnd_changed_cb callback, uid_t uid);
+/**
+ * @internal
+ * @brief Updates the notification setting if the pacakge is installed or updated.
+ * @since_tizen 3.0
+ * @param[in] package_name
+ * @param[in] uid User id
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * otherwise any other value on failure
+ * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NOTIFICATION_ERROR_FROM_DB Error from DB query
+ * @par sample code:
+ * @code
+#include <notification_setting.h>
+...
+{
+ int ret;
+
+ ret = notification_setting_insert_package_for_uid(pkg_name, uid);
+ if (ret = NOTIFICATION_ERROR_NONE)
+ return;
+}
+ * @endcode
+ */
int notification_setting_insert_package_for_uid(const char *package_name, uid_t uid);
+
+/**
+ * @internal
+ * @brief Deletes the notification setting if the pacakge is uninstalled.
+ * @since_tizen 3.0
+ * @param[in] package_name
+ * @param[in] uid User id
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * otherwise any other value on failure
+ * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NOTIFICATION_ERROR_FROM_DB Error from DB query
+ * @par sample code:
+ * @code
+#include <notification_setting.h>
+...
+{
+ int ret;
+
+ ret = notification_setting_delete_package_for_uid(pkg_name, uid);
+ if (ret = NOTIFICATION_ERROR_NONE)
+ return;
+}
+ * @endcode
+ */
int notification_setting_delete_package_for_uid(const char *package_name, uid_t uid);
+
+/**
+ * @internal
+ * @brief Updates the notification setting.
+ * @since_tizen 3.0
+ * @param[in] setting Notification setting handle
+ * @param[in] uid User id
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * otherwise any other value on failure
+ * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #NOTIFICATION_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #NOTIFICATION_ERROR_IO_ERROR I/O error
+ * @retval #NOTIFICATION_ERROR_SERVICE_NOT_READY No response from notification service
+ * @retval #NOTIFICATION_ERROR_PERMISSION_DENIED Permission denied
+ * @par sample code:
+ * @code
+#include <notification_setting.h>
+...
+{
+ int ret;
+ notification_setting_h setting;
+
+ // Get setting data
+
+ // Update setting data
+
+ ret = notification_setting_update_setting_for_uid(setting, uid);
+ if (ret = NOTIFICATION_ERROR_NONE)
+ return;
+}
+ * @endcode
+ */
int notification_setting_update_setting_for_uid(notification_setting_h setting, uid_t uid);
/* OLD IMPLEMENTATION */
projects / platform / core / api / notification.git / commitdiff