/**
* @brief Sets an absolute path for an image file to display on the notification view.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification image type
* @param[in] image_path The image file full path
/**
* @brief Gets the absolute path of an image file.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks Do not free @a image_path. It will be freed when notification_free() is called.
* @param[in] noti Notification handle
* @param[in] type Notification image type
/**
* @brief Sets a timestamp.
* @details If input_time is @c 0, time information is taken from the current time.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] input_time The input time
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets a timestamp.
* @details If ret_time is @c 0, time information is not set before.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] ret_time The return time value
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets an insertion timestamp of the notification.
* @details If ret_time is @c 0, this notification data is not inserted before.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] ret_time The return time value
* @return #NOTIFICATION_ERROR_NONE on success,
* If the value is #NOTIFICATION_COUNT_POS_IN, count is displayed in the text when text has %d format.
* If the value is #NOTIFICATION_COUNT_POS_RIGHT, count is displayed at the right of the text.
* Variable parameters should be terminated #NOTIFICATION_VARIABLE_TYPE_NONE.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[in] text The basic text
/**
* @brief Gets the text from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[out] text The notification text
/**
* @brief Sets the timestamp to display on the notification view.
* @details The timestamp will be converted to a formatted string and it will be displayed on the set text area.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[in] time The timestamp
/**
* @brief Gets the timestamp from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification text type
* @param[in] time The pointer of time stamp
/**
* @internal
* @brief Sets the text domain to localize the notification.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] domain The text domain
* @param[in] dir The text dir
/**
* @internal
* @brief Gets the text domain from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks Do not free returned domain and dir. They are freed when notification_free() or notification_free_list() is called.
* @param[in] noti The notification handle
* @param[out] domain The domain
/**
* @brief Sets the sound type for the notification.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification sound type
* @param[in] path The user sound file path
/**
* @brief Gets the sound type from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] type The notification sound type
* @param[out] path The user sound file path
/**
* @brief Sets the vibration type for the notification.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type The notification vibration type
* @param[in] path The user vibration file path
/**
* @brief Gets the vibrate type from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] type The notification sound type
* @param[out] path The user vibration file path
/**
* @brief Sets the LED displaying option.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] operation The LED notification operation
* @param[in] led_argb The notification led color
/**
* @brief Gets the LED displaying option from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] operation The LED notification operation
* @param[out] led_argb The notification LED color
/**
* @brief Sets the time period of flashing the LED.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] on_ms The time for turning on the LED
* @param[in] off_ms The time for turning off the LED
/**
* @brief Gets the time period of flashing the LED from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] on_ms The time for turning on the LED
* @param[out] off_ms The time for turning on the LED
/**
* @brief Sets the launch option for a notification.
* @details When notification data selected in display application, application launched by app_control_send_launch_request with app_control handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] type Launching option type
* @param[in] option App Control handler
/**
* @brief Gets the launch option from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks You must release @a app_control using app_control_destroy().
* @param[in] noti The notification handle
* @param[in] type Launching option type
/**
* @brief Sets the property of the notification.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] flags The property with | operation
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets the property of the notification from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] flags The notification property
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Sets applications to display the notification.
* @details All display application is enable(NOTIFICATION_DISPLAY_APP_ALL) if you are not call this API.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] applist The with | operation
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets the application list displaying the notification from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] applist The display application list
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Sets the initial size for the ongoing type.
* @details After notification_post() call, the size is not updated.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] size The double type size
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets the progress size.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] size The progress size
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Sets the initial progress for the ongoing type.
* @details After the notification_post() call, the progress is not updated.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] percentage The progress percentage
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets the progress from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks At the end of the operation, the progress should be @c 1.0.
* @param[in] noti The notification handle
* @param[out] percentage The progress percentage
/**
* @brief Sets the layout of the notification view.
* @details Caller can set displaying layout of notification.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[in] layout The type of layout
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets the layout of the notification view from the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] layout The type of layout
* @return #NOTIFICATION_ERROR_NONE on success,
/**
* @brief Gets the type of a notification.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @param[out] type The notification type
* @return #NOTIFICATION_ERROR_NONE on success,
* @brief Inserts a notification.
* @details The notification will be inserted to the database and then it will appear in the notification area.
* When notification_create() is called, if priv_id is #NOTIFICATION_PRIV_ID_NONE, priv_id returns the internally set priv_id.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] noti The notification handle
/**
* @brief Updates notification data.
* @details The updated notification will appear in the notification area.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] noti The notification handle that is created by notification_create()
* @internal
* @brief Updates a notification, asynchronously.
* @details The updated notification will appear in the notification area.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @remarks This function updates the notification asynchronously.
/**
* @brief Deletes a notification with the given handle.
* @details notification_delete() removes notification data from database and notification_free() releases memory of notification data.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] noti The notification handle
* @details Available type is #NOTIFICATION_TYPE_NOTI and #NOTIFICATION_TYPE_ONGOING.
* #NOTIFICATION_TYPE_NOTI is remaining notification data even if device is restarted.
* #NOTIFICATION_TYPE_ONGOING can display progressive feather, but notification data is removed after device is restarted.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
* @param[in] type The notification type
* @return Notification handle(notification_h) on success,
/**
* @brief Creates a notification clone.
* @details Newly created notification handle is returned.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @remarks This cloned notification handle should be freed using notification_free().
* @param[in] noti The notification handle
* @param[out] clone The newly created notification handle that has same with input @a noti
/**
* @brief Frees the internal structure data of a notification handle.
* @details Internal data of a notification handle is released. Data of the inserted notification is not deleted.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti The notification handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @internal
* @brief Returns the notification list handle.
* @details If count is equal to @c -1, all notifications are returned.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] type The notification type
* @internal
* @brief Returns the notification detail list handle of grouping data.
* @details If count is equal to c -1, all notifications are returned.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] pkgname The caller application package name
/**
* @internal
* @brief Frees a notification list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] list The notification list handle
* @internal
* @brief Registers a callback for all notification events.
* @details The registered callback could be called for all notification events.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] changed_cb The callback function
/**
* @internal
* @brief Unregisters a callback for all notification events.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] changed_cb The callback function
/**
* @brief Sets the tag of the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti Notification handle
* @param[in] tag tag for loading notification handle
* @return #NOTIFICATION_ERROR_NONE on success, other value on failure
/**
* @brief Gets the tag of the notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @param[in] noti Notification handle
* @param[out] tag tag for loading notification handle
* @return #NOTIFICATION_ERROR_NONE on success, other value on failure
/**
* @brief Loads a notification from the notification's database with the tag.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @remarks The specific error code can be obtained using the get_last_result() method. Error codes are described in Exception section.
/**
* @brief Deletes all notifications of the given type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] type Notification type
/**
* @brief Posts a notification.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/notification
* @param[in] noti Notification handle
/**
* @brief Enumeration for notification layout type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_ly_type {
NOTIFICATION_LY_NONE = 0,
/**
* @brief Enumeration for notification lauch option type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_launch_option_type {
NOTIFICATION_LAUNCH_OPTION_APP_CONTROL = 1,
/**
* @brief Enumeration for notification sound type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_sound_type {
NOTIFICATION_SOUND_TYPE_NONE = -1,
/**
* @brief Enumeration for notification vibration type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_vibration_type {
NOTIFICATION_VIBRATION_TYPE_NONE = -1,
/**
* @brief Enumeration for notification LED operation.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_led_op {
NOTIFICATION_LED_OP_OFF = -1,
/**
* @brief This will be deprecated.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_count_display_type {
NOTIFICATION_COUNT_DISPLAY_TYPE_NONE = -1, /**< None */
/**
* @brief Enumeration for notification text type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_text_type {
NOTIFICATION_TEXT_TYPE_NONE = -1,
/**
* @brief Enumeration for image type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_image_type {
NOTIFICATION_IMAGE_TYPE_NONE = -1,
/**
* @brief Enumeration for application execution type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_execute_type {
NOTIFICATION_EXECUTE_TYPE_NONE = -1,
/**
* @brief Enumeration for notification type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_type {
NOTIFICATION_TYPE_NONE = -1,
/**
* @brief Enumeration for Group ID.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum _notification_group_id {
NOTIFICATION_GROUP_ID_NONE = -1,/**< Not Grouping */
/**
* @brief Enumeration for Private ID.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum _notification_priv_id {
NOTIFICATION_PRIV_ID_NONE = -1,
/**
* @brief Enumeration for notification property.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum _notification_property {
NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE = 0x00000001,
/**
* @brief Enumeration for display application list.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum _notificaton_display_applist {
NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY = 0x00000001,/**< Notification Tray(Quickpanel) */
/**
* @brief Enumeration for notification operation code.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_op_type {
NOTIFICATION_OP_NONE = 0, /**< Default */
/**
* @brief Enumeration for notification operation data code
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_op_data_type {
NOTIFICATION_OP_DATA_MIN = 0, /**< Default */
/**
* @brief Enumeration for notification count position in the text.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notifcation_count_pos_type {
NOTIFICATION_COUNT_POS_NONE = -1,
/**
* @brief Enumeration for notification variable parameter type.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_variable_type {
NOTIFICATION_VARIABLE_TYPE_NONE = -1,
/**
* @brief Notification handle.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef struct _notification *notification_h;
/**
* @brief The structure for notification operation.
- * @since_tizen 2.3
+ * @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef struct _notification_op {
notification_op_type_e type; /**< Notification operation type */