* limitations under the License.
*/
+
#ifndef __NOTIFICATION_H__
#define __NOTIFICATION_H__
+
#include <time.h>
#include <bundle.h>
#include <app.h>
+
#include <notification_error.h>
#include <notification_type.h>
#include <notification_status.h>
+
#ifdef __cplusplus
extern "C" {
#endif
+
/**
* @file notification.h
* @brief This file contains the notification API.
*/
+
/**
* @addtogroup NOTIFICATION_MODULE
* @{
*/
+
/**
* @brief Sets an absolute path for an image file to display on the notification view.
* @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] noti The notification handle
+ * @param[in] type The notification image type
* @param[in] image_path The image file full path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see #notification_image_type_e
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- noti_err = notification_set_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, APP_IMAGE_FULL_PATH);
+ noti_err = notification_set_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, APP_IMAGE_FULL_PATH);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
* @endcode
*/
-int notification_set_image(notification_h noti, notification_image_type_e type,
- const char *image_path);
+int notification_set_image(notification_h noti, notification_image_type_e type, const char *image_path);
+
/**
* @brief Gets the absolute path of an image file.
* @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
- * @param[out] image_path image file full path
- * @return NOTIFICATION_ERROR_NONE on success, other value on failure
+ * @param[out] image_path Image file full path
+ * @return NOTIFICATION_ERROR_NONE on success,
+ * other value on failure
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see notification_create()
* @par Sample code:
* @code
- #include <notification.h>
- ...
- {
+#include <notification.h>
+
+{
char *image_path = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_get_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, &image_path);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_image(noti, NOTIFICATION_IMAGE_TYPE_ICON, &image_path);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
- }
+}
* @endcode
*/
-int notification_get_image(notification_h noti, notification_image_type_e type,
- char **image_path);
+int notification_get_image(notification_h noti, notification_image_type_e type, char **image_path);
+
/**
* @brief Sets a timestamp.
* @details If input_time is @c 0, time information is taken from the current time.
* @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. If you want the time stamp is not be shown, set this as NOTIFICATION_DO_NOT_SHOW_TIME_STAMP
+ * @param[in] noti The notification handle
+ * @param[in] input_time The input time. If you want the time stamp to not be shown, set this as NOTIFICATION_DO_NOT_SHOW_TIME_STAMP
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see notification_create()
* @par Sample code:
* @code
#include <notification.h>
- ...
- {
- notification_h noti = NULL;
- int noti_err = NOTIFICATION_ERROR_NONE;
-
- noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
- return;
- }
-
- noti_err = notification_set_time(noti, time(NULL));
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+
+{
+ notification_h noti = NULL;
+ int noti_err = NOTIFICATION_ERROR_NONE;
+
+ noti = notification_create(NOTIFICATION_TYPE_NOTI);
+ if (noti == NULL)
+ return;
+
+ noti_err = notification_set_time(noti, time(NULL));
+ if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
- }
- }
+ }
+}
* @endcode
*/
int notification_set_time(notification_h noti, time_t input_time);
+
/**
* @brief Gets a timestamp.
* @details If ret_time is @c 0, time information is not set before.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] ret_time The return time value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @see notification_create()
* @par Sample code:
* @code
- #include <notification.h>
- ...
- {
+#include <notification.h>
+
+{
time_t ret_time;
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_get_time(noti, &ret_time);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_time(noti, &ret_time);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
- }
+}
* @endcode
*/
int notification_get_time(notification_h noti, time_t *ret_time);
+
/**
* @brief Gets an insertion timestamp of the notification.
* @details If ret_time is @c 0, this notification data is not inserted before.
* @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
+ * @param[in] noti The notification handle
+ * @param[out] ret_time The return time value
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
- #include <notification.h>
- ...
- {
+#include <notification.h>
+
+{
time_t ret_time;
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_get_insert_time(noti, &ret_time);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_insert_time(noti, &ret_time);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
- }
+}
* @endcode
*/
int notification_get_insert_time(notification_h noti, time_t *ret_time);
+
/**
* @brief Sets the text to display on the notification view.
* @details Sets title, content string. If the text is formatted data (only %d, %f, %s are supported), type - value pair should be set.
- * If %d, the type #NOTIFICATION_VARIABLE_TYPE_INT and the value is an integer.
- * If %f, the type #NOTIFICATION_VARIABLE_TYPE_DOUBLE and the value is a double.
- * If %s, the type #NOTIFICATION_VARIABLE_TYPE_STRING and the value is a string.
- * If the type is #NOTIFICATION_VARIABLE_TYPE_COUNT, notification count is displaying with text.
- * If the value is #NOTIFICATION_COUNT_POS_LEFT, count is displayed at the left of the text.
- * If the value is #NOTIFICATION_COUNT_POS_IN, count is displayed in the text when text has %d format.
- * If the value is #NOTIFICATION_COUNT_POS_RIGHT, count is displayed at the right of the text.
- * Variable parameters should be terminated #NOTIFICATION_VARIABLE_TYPE_NONE.
+ * If %d, the type #NOTIFICATION_VARIABLE_TYPE_INT and the value is an integer.
+ * If %f, the type #NOTIFICATION_VARIABLE_TYPE_DOUBLE and the value is a double.
+ * If %s, the type #NOTIFICATION_VARIABLE_TYPE_STRING and the value is a string.
+ * If the type is #NOTIFICATION_VARIABLE_TYPE_COUNT, notification count is displaying with text.
+ * If the value is #NOTIFICATION_COUNT_POS_LEFT, count is displayed at the left of the text.
+ * If the value is #NOTIFICATION_COUNT_POS_IN, count is displayed in the text when text has %d format.
+ * If the value is #NOTIFICATION_COUNT_POS_RIGHT, count is displayed at the right of the text.
+ * Variable parameters should be terminated #NOTIFICATION_VARIABLE_TYPE_NONE.
* @since_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
- * @param[in] key The text key for localization
+ * @param[in] noti The notification handle
+ * @param[in] type The notification text type
+ * @param[in] text The basic text
+ * @param[in] key The text key for localization
* @param[in] args_type The variable parameter that type - value pair
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre notification handle should be created by notification_create().
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- noti_err = notification_set_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, "I'm Title", "IDS_APP_BODY_IM_TITLE", NOTIFICATION_VARIABLE_TYPE_NONE);
+ noti_err = notification_set_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, "I'm Title",
+ "IDS_APP_BODY_IM_TITLE", NOTIFICATION_VARIABLE_TYPE_NONE);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
int notification_set_text(notification_h noti, notification_text_type_e type,
const char *text, const char *key, int args_type, ...);
+
/**
* @brief Gets the text from the notification handle.
* @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] noti The notification handle
+ * @param[in] type The notification text type
* @param[out] text The notification text
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *text = NULL;
- noti_err = notification_get_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, &text);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_text(noti, NOTIFICATION_TEXT_TYPE_TITLE, &text);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_get_text(notification_h noti, notification_text_type_e type,
- char **text);
+int notification_get_text(notification_h noti, notification_text_type_e type, char **text);
+
/**
* @brief Sets the timestamp to display on the notification view.
* @param[in] time The timestamp
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
*/
-int notification_set_time_to_text(notification_h noti,
- notification_text_type_e type, time_t time);
+int notification_set_time_to_text(notification_h noti, notification_text_type_e type, time_t time);
+
/**
* @brief Gets the timestamp from the notification handle.
* @param[in] time The pointer of time stamp
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
*/
-int notification_get_time_from_text(notification_h noti,
- notification_text_type_e type, time_t *time);
+int notification_get_time_from_text(notification_h noti, notification_text_type_e type, time_t *time);
+
/**
* @brief Sets the sound type for the notification.
* @param[in] path The user sound file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_set_sound(noti, NOTIFICATION_SOUND_TYPE_DEFAULT, NULL);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_set_sound(noti, NOTIFICATION_SOUND_TYPE_DEFAULT, NULL);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_set_sound(notification_h noti,
- notification_sound_type_e type, const char *path);
+int notification_set_sound(notification_h noti, notification_sound_type_e type, const char *path);
+
/**
* @brief Gets the sound type from the notification handle.
* @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
+ * @param[in] noti The notification handle
+ * @param[out] type The notification sound type
+ * @param[out] path The user sound file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
notification_sound_type_e type = NOTIFICATION_SOUND_TYPE_NONE;
- noti_err = notification_get_sound(noti, &type, NULL);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_sound(noti, &type, NULL);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_get_sound(notification_h noti,
- notification_sound_type_e *type, const char **path);
+int notification_get_sound(notification_h noti, notification_sound_type_e *type, const char **path);
+
/**
* @brief Sets the vibration type for the notification.
* @param[in] path The user vibration file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_set_vibration(noti, NOTIFICATION_VIBRATION_TYPE_DEFAULT, NULL);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_set_vibration(noti, NOTIFICATION_VIBRATION_TYPE_DEFAULT, NULL);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_set_vibration(notification_h noti,
- notification_vibration_type_e type, const char *path);
+int notification_set_vibration(notification_h noti, notification_vibration_type_e type, const char *path);
+
/**
* @brief Gets the vibrate type from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] type The notification sound type
* @param[out] path The user vibration file path
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
notification_vibration_type_e type = NOTIFICATION_VIBRATION_TYPE_NONE;
- noti_err = notification_get_vibration(noti, &type, NULL);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_vibration(noti, &type, NULL);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_get_vibration(notification_h noti,
- notification_vibration_type_e *type, const char **path);
+int notification_get_vibration(notification_h noti, notification_vibration_type_e *type, const char **path);
+
/**
* @brief Sets the LED displaying option.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[in] operation The LED notification operation
- * @param[in] led_argb The notification led color
+ * @param[in] led_argb The notification LED color
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_set_led(noti, NOTIFICATION_LED_OP_ON, NULL);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_set_led(noti, NOTIFICATION_LED_OP_ON, NULL);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_set_led(notification_h noti, notification_led_op_e operation,
- int led_argb);
+int notification_set_led(notification_h noti, notification_led_op_e operation, int led_argb);
+
/**
* @brief Gets the LED displaying option from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] operation The LED notification operation
- * @param[out] led_argb The notification LED color
+ * @param[out] led_argb The notification LED color
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
notification_led_type_e type = NOTIFICATION_LED_OP_OFF;
- noti_err = notification_get_led(noti, &type, NULL);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_led(noti, &type, NULL);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_get_led(notification_h noti, notification_led_op_e *operation,
- int *led_argb);
+int notification_get_led(notification_h noti, notification_led_op_e *operation, int *led_argb);
+
/**
* @brief Sets the time period of flashing the LED.
* @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] 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
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_set_led_time_period(noti, 100, 100);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_set_led_time_period(noti, 100, 100);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_set_led_time_period(notification_h noti, int on_ms,
- int off_ms);
+int notification_set_led_time_period(notification_h noti, int on_ms, int off_ms);
+
/**
* @brief Gets the time period of flashing the LED from the notification handle.
* @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[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
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
int led_on_ms = 0;
int led_off_ms = 0;
- noti_err = notification_get_led_time_period(noti, &led_on_ms, &led_off_ms);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_led_time_period(noti, &led_on_ms, &led_off_ms);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
-int notification_get_led_time_period(notification_h noti, int *on_ms,
- int *off_ms);
+int notification_get_led_time_period(notification_h noti, int *on_ms, int *off_ms);
+
/**
* @brief Sets the launch option for a notification.
* @param[in] option App Control handler
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
app_control_h app_control = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- ...
+ // Do something
app_control_create(&app_control);
app_control_set_app_id(app_control, "org.tizen.app");
- ...
+ // Do something
- noti_err = notification_set_launch_option(noti, NOTIFICATION_LAUNCH_OPTION_APP_CONTROL, (void *)app_control);
+ noti_err = notification_set_launch_option(noti, NOTIFICATION_LAUNCH_OPTION_APP_CONTROL, (void *)app_control);
if (noti_err != NOTIFICATION_ERROR_NONE) {
+ app_control_destroy(app_control);
notification_free(noti);
return;
}
}
* @endcode
*/
-int notification_set_launch_option(notification_h noti,
- notification_launch_option_type type, void *option);
+int notification_set_launch_option(notification_h noti, notification_launch_option_type type, void *option);
+
/**
* @brief Gets the launch option from the notification handle.
* @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] noti The notification handle
* @param[in] type Launching option type
* @param[out] option The pointer of App Control handler
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
app_control_h app_control = NULL;
app_control_create(&app_control);
- ...
+ // Do something
noti_err = notification_get_launch_option(noti, NOTIFICATION_LAUNCH_OPTION_APP_CONTROL, (void *)&app_control);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
- notification_free(noti);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
}
* @endcode
*/
-int notification_get_launch_option(notification_h noti,
- notification_launch_option_type type, void *option);
+int notification_get_launch_option(notification_h noti, notification_launch_option_type type, void *option);
+
/**
* @brief Sets the handler for a specific event.
- * @details When some event occurs on notification, application launched by app_control_send_launch_request with app_control handle.\n
+ * @details When some event occurs on notification, application launched by app_control_send_launch_request with app_control handle. \n
* Setting event handler of a button means that the notification will show the button.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] noti The notification handle
- * @param[in] event_type Launching option type
+ * @param[in] event_type Event type
* @param[in] event_handler App control handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_event_type_e
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
app_control_h app_control = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- ...
+ // Do something
app_control_create(&app_control);
app_control_set_app_id(app_control, "org.tizen.app");
- ...
+ // Do something
- noti_err = notification_set_event_handler(noti, NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1, app_control);
+ noti_err = notification_set_event_handler(noti, NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1, app_control);
if (noti_err != NOTIFICATION_ERROR_NONE) {
+ app_control_destroy(app_control);
notification_free(noti);
return;
}
}
* @endcode
*/
-int notification_set_event_handler(notification_h noti,
- notification_event_type_e event_type,
- app_control_h event_handler);
+int notification_set_event_handler(notification_h noti, notification_event_type_e event_type, app_control_h event_handler);
+
/**
* @brief Gets the event handler of a specific event.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] noti The notification handle
* @param[in] event_type Launching option type
- * @param[out] event_handler App control handle
+ * @param[out] event_handler The handler of App Control
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_event_type_e
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
app_control_h app_control = NULL;
app_control_create(&app_control);
- ...
+ // Do something
noti_err = notification_get_event_handler(noti, NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1, &app_control);
if (noti_err != NOTIFICATION_ERROR_NONE) {
}
* @endcode
*/
-int notification_get_event_handler(notification_h noti,
- notification_event_type_e event_type,
- app_control_h *event_handler);
+int notification_get_event_handler(notification_h noti, notification_event_type_e event_type, app_control_h *event_handler);
+
/**
* @brief Sets the property of the notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[in] flags The property with | operation
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
bundle *b = NULL;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- noti_err = notification_set_property(noti, NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE | NOTIFICATION_PROP_DISABLE_APP_LAUNCH);
+ noti_err = notification_set_property(noti, NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE | NOTIFICATION_PROP_DISABLE_APP_LAUNCH);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
*/
int notification_set_property(notification_h noti, int flags);
+
/**
* @brief Gets the property of the notification from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] flags The notification property
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
int flags = 0;
- noti_err = notification_get_property(noti, &flags);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_property(noti, &flags);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_get_property(notification_h noti, int *flags);
+
/**
* @brief Sets applications to display the notification.
- * @details All display application is enable(NOTIFICATION_DISPLAY_APP_ALL) if you are not call this API.
+ * @details All display application is enabled(NOTIFICATION_DISPLAY_APP_ALL) if you do not call this API.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[in] applist The with | operation
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
bundle *b = NULL;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- noti_err = notification_set_display_applist(noti, NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY | NOTIFICATION_DISPLAY_APP_TICKER | NOTIFICATION_DISPLAY_APP_INDICATOR);
+ noti_err = notification_set_display_applist(noti, NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY |
+ NOTIFICATION_DISPLAY_APP_TICKER | NOTIFICATION_DISPLAY_APP_INDICATOR);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
}
}
-}
* @endcode
*/
int notification_set_display_applist(notification_h noti, int applist);
+
/**
* @brief Gets the application list displaying the notification from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] applist The display application list
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
int applist = 0;
- noti_err = notification_get_display_applist(noti, &applist);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_display_applist(noti, &applist);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_get_display_applist(notification_h noti, int *applist);
+
/**
* @brief Sets the initial size for the ongoing type.
* @details After notification_post() call, the size is not updated.
* @param[in] size The double type size
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- noti_err = notification_set_size(noti, 0.0);
+ noti_err = notification_set_size(noti, 0.0);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
*/
int notification_set_size(notification_h noti, double size);
+
/**
* @brief Gets the progress size.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] size The progress size
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
double size = 0.0;
- noti_err = notification_get_size(noti, &size);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_size(noti, &size);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
}
* @endcode
*/
int notification_get_size(notification_h noti, double *size);
+
/**
* @brief Sets the initial progress for the ongoing type.
* @details After the notification_post() call, the progress is not updated.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[in] percentage The progress percentage
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- noti_err = notification_set_progress(noti, 0.0);
+ noti_err = notification_set_progress(noti, 0.0);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
return;
*/
int notification_set_progress(notification_h noti, double percentage);
+
/**
* @brief Gets the progress from the notification handle.
* @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[in] noti The notification handle
* @param[out] percentage The progress percentage
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
double percentage = 0.0;
- noti_err = notification_get_progress(noti, &percentage);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_progress(noti, &percentage);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_get_progress(notification_h noti, double *percentage);
+
/**
* @brief Sets the layout of the notification view.
* @details Caller can set displaying layout of notification.
* @param[in] layout The type of layout
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_ly_type_e
*/
int notification_set_layout(notification_h noti, notification_ly_type_e layout);
+
/**
* @brief Gets the layout of the notification view from the notification handle.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] layout The type of layout
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @see #notification_ly_type_e
*/
-int notification_get_layout(notification_h noti,
- notification_ly_type_e *layout);
+int notification_get_layout(notification_h noti, notification_ly_type_e *layout);
+
/**
* @brief Gets the type of a notification.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
- * @param[in] noti The notification handle
+ * @param[in] noti The notification handle
* @param[out] type The notification type
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
int noti_err = NOTIFICATION_ERROR_NONE;
notification_type_e type;
- noti_err = notification_get_type(noti, &type);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_get_type(noti, &type);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
}
* @endcode
*/
int notification_get_type(notification_h noti, notification_type_e *type);
+
+
/**
* @brief Updates notification data.
* @details The updated notification will appear in the notification area.
* @param[in] noti The notification handle that is created by notification_create()
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @retval #NOTIFICATION_ERROR_NOT_EXIST_ID Priv ID does not exist
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_update(NULL);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_update(NULL);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
}
* @endcode
*/
int notification_update(notification_h noti);
+
/**
* @brief Deletes a notification with the given handle.
* @details notification_delete() removes notification data from database and notification_free() releases memory of notification data.
* @param[in] noti The notification handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @retval NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
notificaton_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- ...
+ // Do something
- noti_err = notification_delete(noti);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_delete(noti);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
- }
+}
* @endcode
*/
int notification_delete(notification_h noti);
+
/**
* @brief Creates internal structure data and returns a 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 progress on a notification with #NOTIFICATION_LY_ONGOING_PROGRESS layout.
+ * #NOTIFICATION_TYPE_NOTI is remaining notification data even if device is restarted.
+ * #NOTIFICATION_TYPE_ONGOING can display progress on a notification with #NOTIFICATION_LY_ONGOING_PROGRESS layout.
* @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
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- ...
+
+ // Do something
+
}
* @endcode
*/
notification_h notification_create(notification_type_e type);
+
/**
* @brief Creates a notification clone.
* @details Newly created notification handle is returned.
* @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[in] noti The notification handle
* @param[out] clone The newly created notification handle that has same with input @a noti
* @return #NOTIFICATION_ERROR_NONE if success,
* otherwise any other value if failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_type_e
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = notification_create(NOTIFICATION_TYPE_NOTI);
notification_h clone = NULL;
notification_clone(noti, &clone);
- ...
+
+ // Do something
+
}
* @endcode
*/
int notification_clone(notification_h noti, notification_h *clone);
+
/**
* @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.
* @param[in] noti The notification handle
* @return #NOTIFICATION_ERROR_NONE on success,
* otherwise any other value on failure
- * @retval #NOTIFICATION_ERROR_NONE Success
+ * @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @pre Notification handle should be created by notification_create().
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- ...
+
+ // Do something
noti_err = notification_free(noti);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_free(notification_h noti);
+
/**
* @}
*/
+
/**
* @addtogroup NOTIFICATION_MODULE
* @{
*/
+
/**
* @brief Sets the tag of the notification handle.
* @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
+ * @param[in] tag Tag for loading notification handle
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- ...
+
+ // Do something
noti_err = notification_set_tag(noti, tag);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_set_tag(notification_h noti, const char *tag);
+
/**
* @brief Gets the tag of the notification handle.
* @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
+ * @param[out] tag Tag for loading notification handle
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * other value on failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
int noti_err = NOTIFICATION_ERROR_NONE;
const char *tag = NULL;
- ...
+ // Do something
noti_err = notification_get_tag(noti, &tag);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_get_tag(notification_h noti, const char **tag);
+
/**
* @brief Loads a notification from the notification's database with the tag.
* @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.
- * @param[in] tag tag for loading notification handle
- * @return Notification handle(notification_h) on success, NULL on failure
+ * @param[in] tag Tag for loading notification handle
+ * @return Notification handle(notification_h) on success,
+ * NULL on failure
* @retval notification_h Success
* @retval NULL Failure
* @exception #NOTIFICATION_ERROR_NONE Success
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
noti = notification_load_by_tag(tag);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- ...
+
+ // Do something
+
}
* @endcode
*/
notification_h notification_load_by_tag(const char *tag);
+
/**
* @brief Deletes all notifications of the given type.
* @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
- * @return #NOTIFICATION_ERROR_NONE if success, other value if failure
+ * @return #NOTIFICATION_ERROR_NONE if success,
+ * other value if failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_delete_all(NOTIFICATION_TYPE_NOTI);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_delete_all(NOTIFICATION_TYPE_NOTI);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_delete_all(notification_type_e type);
+
/**
* @brief Posts a notification.
* @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
- * @return #NOTIFICATION_ERROR_NONE if success, other value if failure
+ * @return #NOTIFICATION_ERROR_NONE if success,
+ * other value if failure
* @retval #NOTIFICATION_ERROR_NONE Success
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #NOTIFICATION_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method
* @par Sample code:
* @code
#include <notification.h>
-...
- {
+
+{
int noti_err = NOTIFICATION_ERROR_NONE;
- noti_err = notification_post(noti);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ noti_err = notification_post(noti);
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_post(notification_h noti);
+
/**
- * @brief Gets the package name of the notification
+ * @brief Gets the package name of the notification.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] noti Notification handle
* @param[out] pkgname The package name of the notification
- * @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * otherwise a negative error value
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *pkgname = NULL;
- ...
+ // Do something
- noti_err = notification_get_pkgname(noti, &pkgname);
+ noti_err = notification_get_pkgname(noti, &pkgname);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
*/
int notification_get_pkgname(notification_h noti, char **pkgname);
+
/**
- * @brief Adds a button on the notification
+ * @brief Adds a button on the notification.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] noti Notification handle
* @param[in] button_index Button index
- * @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * otherwise a negative error value
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *pkgname = NULL;
- ...
+ // Do something
- noti_err = notification_add_button(noti, NOTIFICATION_BUTTON_1);
+ noti_err = notification_add_button(noti, NOTIFICATION_BUTTON_1);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
}
* @endcode
*/
-int notification_add_button(notification_h noti,
- notification_button_index_e button_index);
+int notification_add_button(notification_h noti, notification_button_index_e button_index);
/**
- * @brief Removes a button on the notification
+ * @brief Removes a button on the notification.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] noti Notification handle
* @param[in] button_index Button index
- * @return #NOTIFICATION_ERROR_NONE on success, otherwise a negative error value
+ * @return #NOTIFICATION_ERROR_NONE on success,
+ * otherwise a negative error value
* @retval NOTIFICATION_ERROR_NONE Success
* @retval NOTIFICATION_ERROR_INVALID_PARAMETER Invalid input value
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
char *pkgname = NULL;
- ...
+ // Do something
- noti_err = notification_remove_button(noti, NOTIFICATION_BUTTON_1);
+ noti_err = notification_remove_button(noti, NOTIFICATION_BUTTON_1);
if (noti_err != NOTIFICATION_ERROR_NONE) {
notification_free(noti);
}
* @endcode
*/
-int notification_remove_button(notification_h noti,
- notification_button_index_e button_index);
+int notification_remove_button(notification_h noti, notification_button_index_e button_index);
+
/**
- * @brief Sets the 'auto remove' option of the active notification
- * @details The 'auto remove' option let the active notification be removed in several seconds after it shows. Default value is true.
+ * @brief Sets the 'auto remove' option of the active notification.
+ * @details The 'auto remove' option lets the active notification be removed several seconds after it shows. Default value is true.
* @remarks When 'auto_remove' is set as false, the active notification will not be removed
- as long as the user removes the active notification or the app which posted the active notification removes the active notification.
+ * as long as the user removes the active notification or the app which posted the active notification removes the active notification.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] noti Notification handle
* @param[in] auto_remove Auto remove option
- * @return #NOTIFICATION_ERROR_NONE On success, other value if failure
+ * @return #NOTIFICATION_ERROR_NONE On success,
+ * other value if failure
* @retval #NOTIFICATION_ERROR_INVALID_PARAMETER Invalid parameter
* @see #notification_h
* @see #notification_get_auto_remove
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
int noti_err = NOTIFICATION_ERROR_NONE;
- ...
+ // Do something
noti_err = notification_set_auto_remove(noti, false);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_set_auto_remove(notification_h noti, bool auto_remove);
+
/**
- * @brief Gets the 'auto remove' option of the active notification
- * @details The 'auto remove' option let the active notification be removed in several seconds after it shows. Default value is true.
+ * @brief Gets the 'auto remove' option of the active notification.
+ * @details The 'auto remove' option lets the active notification be removed several seconds after it shows. Default value is true.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @param[in] noti Notification handle
* @param[out] auto_remove Auto remove option
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
int noti_err = NOTIFICATION_ERROR_NONE;
bool auto_remove;
- ...
+ // Do something
noti_err = notification_get_auto_remove(noti, &auto_remove);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_get_auto_remove(notification_h noti, bool *auto_remove);
+
/**
* @brief Saves a notification template to the notification database.
* @details An application can save the created notification as a template for later reuse.
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
int noti_err = NOTIFICATION_ERROR_NONE;
- ...
+ // Do something
noti_err = notification_save_as_template(noti, "CALL_ACCEPT");
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_save_as_template(notification_h noti, const char *template_name);
+
/**
* @brief Loads a notification template from the notification database.
* @details An application can load a saved template and post it.
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
notification_h noti = NULL;
noti = notification_create_from_template("CALL_ACCEPT");
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
- ...
+
}
* @endcode
*/
notification_h notification_create_from_template(const char *template_name);
+
/**
* @brief Gets notification block state.
* @details The user can set the notification block state in settings.
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
int noti_err = NOTIFICATION_ERROR_NONE;
notification_block_state_e state;
- ...
+ // Do something
noti_err = notification_get_noti_block_state(&state);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
* @endcode
*/
int notification_get_noti_block_state(notification_block_state_e *state);
+
/**
* @brief Sets a text input box to reply directly on the notification.
* @details When you add a text input to the active notification, the notification UI will show a text input with a button.
* Note that you are able to make the switching button to the text input box.
* You have to set the app_control which you will set in a text input box to the switching button.
* Refer to the second sample code.
-
* @since_tizen 3.0
* @param[in] noti Notification handle
* @param[in] text_input_max_length The maximum value which can be inputted
* @par Sample code:
* @code
#include <notification.h>
-...
+
{
int noti_err = NOTIFICATION_ERROR_NONE;
notification_h noti = NULL;
app_control = NULL;
noti = notification_create(NOTIFICATION_TYPE_NOTI);
- if (noti == NULL) {
+ if (noti == NULL)
return;
- }
noti_err = notification_set_text_input(noti, 160);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_text(noti,
NOTIFICATION_TEXT_TYPE_TEXT_INPUT_PLACEHOLDER,
"Text message",
NULL,
NOTIFICATION_VARIABLE_TYPE_NONE);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_text(noti,
NOTIFICATION_TEXT_TYPE_TEXT_INPUT_BUTTON,
"SEND",
NULL,
NOTIFICATION_VARIABLE_TYPE_NONE);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_display_applist(noti,
NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY | NOTIFICATION_DISPLAY_APP_ACTIVE);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
- ...
+
+ // Do something
noti_err = app_control_create(&app_control);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = app_control_set_app_id(app_control, appid);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = app_control_set_operation(app_control, APP_CONTROL_OPERATION_DEFAULT);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = notification_set_event_handler(noti,
NOTIFICATION_EVENT_TYPE_CLICK_ON_TEXT_INPUT_BUTTON,
app_control);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = app_control_destroy(app_control);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = notification_post(noti);
- if(noti_err != NOTIFICATION_ERROR_NONE) {
+ if(noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
+
}
-...
{
int noti_err = NOTIFICATION_ERROR_NONE;
}
noti_err = notification_set_text_input(noti, 160);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_text(noti,
NOTIFICATION_TEXT_TYPE_TEXT_INPUT_PLACEHOLDER,
"Text message",
NULL,
NOTIFICATION_VARIABLE_TYPE_NONE);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_text(noti,
NOTIFICATION_TEXT_TYPE_TEXT_INPUT_BUTTON,
"SEND",
NULL,
NOTIFICATION_VARIABLE_TYPE_NONE);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_add_button(notification, NOTIFICATION_BUTTON_1);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_text(notification,
NOTIFICATION_TEXT_TYPE_BUTTON_1,
"reply",
NULL,
NOTIFICATION_VARIABLE_TYPE_NONE);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_display_applist(noti,
NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY | NOTIFICATION_DISPLAY_APP_ACTIVE);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
- ...
+
+ // Do something
noti_err = app_control_create(&app_control);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = app_control_set_app_id(app_control, appid);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = app_control_set_operation(app_control, APP_CONTROL_OPERATION_DEFAULT);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = notification_set_event_handler(notification,
NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1,
app_control);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = notification_set_event_handler(noti,
NOTIFICATION_EVENT_TYPE_CLICK_ON_TEXT_INPUT_BUTTON,
app_control);
- if (noti_err != NOTIFICATION_ERROR_NONE) {
+ if (noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
noti_err = app_control_destroy(app_control);
- if (noti_err != APP_CONTROL_ERROR_NONE) {
+ if (noti_err != APP_CONTROL_ERROR_NONE)
return;
- }
noti_err = notification_post(noti);
- if(noti_err != NOTIFICATION_ERROR_NONE) {
+ if(noti_err != NOTIFICATION_ERROR_NONE)
return;
- }
}
* @endcode
*/
int notification_set_text_input(notification_h noti, int text_input_max_length);
+
/**
* @}
*/
* limitations under the License.
*/
+
#ifndef __NOTIFICATION_TYPE_H__
#define __NOTIFICATION_TYPE_H__
+
#ifdef __cplusplus
extern "C" {
#endif
+
#ifndef NOTIFICATION_DEPRECATED_API
#if 0 /* __GNUC__ */
#define NOTIFICATION_DEPRECATED_API __attribute__((deprecated))
#endif
#endif
+
/**
* @file notification_type.h
* @brief This file contains type definitions and enumerations for Notification API.
*/
+
/**
* @addtogroup NOTIFICATION_MODULE
* @{
*/
+#define NOTIFICATION_DO_NOT_SHOW_TIME_STAMP -1 /**< Do not show time stamp on the notificaion. Could be passed as a argument of notification_set_time() */
-#define NOTIFICATION_DO_NOT_SHOW_TIME_STAMP -1 /**< Do not show time stamp on the notificaion. Could be passed as a argument of notification_set_time() */
/**
* @brief Enumeration for notification layout type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_ly_type {
- NOTIFICATION_LY_NONE = 0,
- /**< Default */
- NOTIFICATION_LY_NOTI_EVENT_SINGLE,
- /**< Layout for notification. Used to inform single event*/
- NOTIFICATION_LY_NOTI_EVENT_MULTIPLE,
- /**< Layout for notification. Used to inform multiple event*/
- NOTIFICATION_LY_NOTI_THUMBNAIL,
- /**< Layout for notification. Used to display images*/
- NOTIFICATION_LY_ONGOING_EVENT,
- /**< Layout for ongoing notification. Used to display text message.
- * notifications with NOTIFICATION_LY_ONGOING_EVENT can not be protected from removing by user since tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */
- NOTIFICATION_LY_ONGOING_PROGRESS,
- /**< Layout for ongoing notification. Used to display progress*/
- NOTIFICATION_LY_MAX,
- /**< TBD */
+ NOTIFICATION_LY_NONE = 0, /**< Default */
+ NOTIFICATION_LY_NOTI_EVENT_SINGLE, /**< Layout for notification. Used to inform single event*/
+ NOTIFICATION_LY_NOTI_EVENT_MULTIPLE, /**< Layout for notification. Used to inform multiple event*/
+ NOTIFICATION_LY_NOTI_THUMBNAIL, /**< Layout for notification. Used to display images*/
+ NOTIFICATION_LY_ONGOING_EVENT, /**< Layout for ongoing notification. Used to display text message.
+ * notifications with NOTIFICATION_LY_ONGOING_EVENT can not be protected from
+ * removing by user since tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */
+ NOTIFICATION_LY_ONGOING_PROGRESS, /**< Layout for ongoing notification. Used to display progress*/
+ NOTIFICATION_LY_MAX, /**< TBD */
} notification_ly_type_e;
+
/**
- * @brief Enumeration for notification launch option type.
+ * @brief Enumeration for notification lauch option type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_launch_option_type {
- NOTIFICATION_LAUNCH_OPTION_APP_CONTROL = 1, /**< Launching with app control */
+ NOTIFICATION_LAUNCH_OPTION_APP_CONTROL = 1,
+ /**< Launching with app control */
} notification_launch_option_type;
+
/**
* @brief Enumeration for event type on notification.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
typedef enum _notification_event_type {
- NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1 = 0, /**< Event type : Click on button 1 */
- NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_2 = 1, /**< Event type : Click on button 2 */
- NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_3 = 2, /**< Event type : Click on button 3 */
- NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_4 = 3, /**< Event type : Click on button 4 */
- NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_5 = 4, /**< Event type : Click on button 5 */
- NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_6 = 5, /**< Event type : Click on button 6 */
- NOTIFICATION_EVENT_TYPE_CLICK_ON_ICON = 6, /**< Event type : Click on icon */
- NOTIFICATION_EVENT_TYPE_CLICK_ON_THUMBNAIL = 7, /**< Event type : Click on thumbnail */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_1 = 0, /**< Event type : Click on button 1 */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_2 = 1, /**< Event type : Click on button 2 */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_3 = 2, /**< Event type : Click on button 3 */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_4 = 3, /**< Event type : Click on button 4 */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_5 = 4, /**< Event type : Click on button 5 */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_BUTTON_6 = 5, /**< Event type : Click on button 6 */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_ICON = 6, /**< Event type : Click on icon */
+ NOTIFICATION_EVENT_TYPE_CLICK_ON_THUMBNAIL = 7, /**< Event type : Click on thumbnail */
NOTIFICATION_EVENT_TYPE_CLICK_ON_TEXT_INPUT_BUTTON = 8, /**< Event type : Click on text_input button(Since 3.0) */
NOTIFICATION_EVENT_TYPE_MAX,
} notification_event_type_e;
+
/**
* @brief Enumeration for notification sound type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_sound_type {
- NOTIFICATION_SOUND_TYPE_NONE = -1,
- /**< Default value. no sound */
- NOTIFICATION_SOUND_TYPE_DEFAULT = 0,
- /**< Default sound */
- NOTIFICATION_SOUND_TYPE_USER_DATA,
- /**< User sound data */
+ NOTIFICATION_SOUND_TYPE_NONE = -1, /**< Default value. no sound */
+ NOTIFICATION_SOUND_TYPE_DEFAULT = 0, /**< Default sound */
+ NOTIFICATION_SOUND_TYPE_USER_DATA, /**< User sound data */
NOTIFICATION_SOUND_TYPE_MAX,
} notification_sound_type_e;
+
/**
* @brief Enumeration for notification vibration type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_vibration_type {
- NOTIFICATION_VIBRATION_TYPE_NONE = -1,
- /**< Default value. No vibration */
- NOTIFICATION_VIBRATION_TYPE_DEFAULT = 0,/**< Default vibrate pattern */
- NOTIFICATION_VIBRATION_TYPE_USER_DATA,
- /**< User vibration data */
+ NOTIFICATION_VIBRATION_TYPE_NONE = -1, /**< Default value. No vibration */
+ NOTIFICATION_VIBRATION_TYPE_DEFAULT = 0, /**< Default vibrate pattern */
+ NOTIFICATION_VIBRATION_TYPE_USER_DATA, /**< User vibration data */
NOTIFICATION_VIBRATION_TYPE_MAX,
} notification_vibration_type_e;
+
/**
* @brief Enumeration for notification LED operation.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_led_op {
- NOTIFICATION_LED_OP_OFF = -1,
- /**< Default value. Disable the LED notification */
- NOTIFICATION_LED_OP_ON = 0,/**< Turn on the LED with default color */
- NOTIFICATION_LED_OP_ON_CUSTOM_COLOR,
- /**< Turn on the LED with custom color */
- NOTIFICATION_LED_OP_MAX,/**< Max flag */
+ NOTIFICATION_LED_OP_OFF = -1, /**< Default value. Disable the LED notification */
+ NOTIFICATION_LED_OP_ON = 0, /**< Turn on the LED with default color */
+ NOTIFICATION_LED_OP_ON_CUSTOM_COLOR, /**< Turn on the LED with custom color */
+ NOTIFICATION_LED_OP_MAX,
} notification_led_op_e;
+
/**
* @deprecated Deprecated since 2.3.1
- * @brief Enumeration for setting display type of count
+ * @brief Enumeration for setting display type of count.
* @since_tizen 2.3
*/
typedef enum _notification_count_display_type {
NOTIFICATION_COUNT_DISPLAY_TYPE_NONE = -1,
- NOTIFICATION_COUNT_DISPLAY_TYPE_LEFT = 0, /**< The number is placed to left */
- NOTIFICATION_COUNT_DISPLAY_TYPE_IN, /**< The number is placed to center */
- NOTIFICATION_COUNT_DISPLAY_TYPE_RIGHT, /**< The number is placed to right */
+ NOTIFICATION_COUNT_DISPLAY_TYPE_LEFT = 0, /**< The number is placed to left */
+ NOTIFICATION_COUNT_DISPLAY_TYPE_IN, /**< The number is placed to center */
+ NOTIFICATION_COUNT_DISPLAY_TYPE_RIGHT, /**< The number is placed to right */
NOTIFICATION_COUNT_DISPLAY_TYPE_MAX,
} notification_count_display_type_e;
+
/**
- * @brief Enumeration for button
+ * @brief Enumeration for button.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
typedef enum _notification_button_index {
NOTIFICATION_BUTTON_6 = 6, /**< button 6 */
} notification_button_index_e;
+
/**
* @brief Enumeration for notification text type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_text_type {
NOTIFICATION_TEXT_TYPE_NONE = -1,
- NOTIFICATION_TEXT_TYPE_TITLE = 0,
- /**< Title */
- NOTIFICATION_TEXT_TYPE_CONTENT,
- /**< Content */
- NOTIFICATION_TEXT_TYPE_CONTENT_FOR_DISPLAY_OPTION_IS_OFF,
- /**< Content for content display option is off of the Settings */
- NOTIFICATION_TEXT_TYPE_EVENT_COUNT,
- /**< Text to display event count */
- NOTIFICATION_TEXT_TYPE_INFO_1,
- /**< Box contents 1 */
- NOTIFICATION_TEXT_TYPE_INFO_SUB_1,
- /**< Box contents 1-1 */
- NOTIFICATION_TEXT_TYPE_INFO_2,
- /**< Box contents 2 */
- NOTIFICATION_TEXT_TYPE_INFO_SUB_2,
- /**< Box contents 2-1 */
- NOTIFICATION_TEXT_TYPE_INFO_3,
- /**< Box contents 3 */
- NOTIFICATION_TEXT_TYPE_INFO_SUB_3,
- /**< Box contents 3-1 */
- NOTIFICATION_TEXT_TYPE_GROUP_TITLE,
- /**< Group title */
- NOTIFICATION_TEXT_TYPE_GROUP_CONTENT,
- /**< Group content */
- NOTIFICATION_TEXT_TYPE_GROUP_CONTENT_FOR_DISPLAY_OPTION_IS_OFF,
- /**< Group content for content display option is off of the Settings */
- NOTIFICATION_TEXT_TYPE_BUTTON_1,
- /**< Text on button 1 */
- NOTIFICATION_TEXT_TYPE_BUTTON_2,
- /**< Text on button 2 */
- NOTIFICATION_TEXT_TYPE_BUTTON_3,
- /**< Text on button 3 */
- NOTIFICATION_TEXT_TYPE_BUTTON_4,
- /**< Text on button 4 */
- NOTIFICATION_TEXT_TYPE_BUTTON_5,
- /**< Text on button 5 */
- NOTIFICATION_TEXT_TYPE_BUTTON_6,
- /**< Text on button 6 */
- NOTIFICATION_TEXT_TYPE_TEXT_INPUT_PLACEHOLDER,
- /**< Guide text on the message reply box(Since 3.0) */
- NOTIFICATION_TEXT_TYPE_TEXT_INPUT_BUTTON,
- /**< Text on button the on message reply box(Since 3.0) */
-
+ NOTIFICATION_TEXT_TYPE_TITLE = 0, /**< Title */
+ NOTIFICATION_TEXT_TYPE_CONTENT, /**< Content */
+ NOTIFICATION_TEXT_TYPE_CONTENT_FOR_DISPLAY_OPTION_IS_OFF, /**< Content for content display option is off of the Settings */
+ NOTIFICATION_TEXT_TYPE_EVENT_COUNT, /**< Text to display event count */
+ NOTIFICATION_TEXT_TYPE_INFO_1, /**< Box contents 1 */
+ NOTIFICATION_TEXT_TYPE_INFO_SUB_1, /**< Box contents 1-1 */
+ NOTIFICATION_TEXT_TYPE_INFO_2, /**< Box contents 2 */
+ NOTIFICATION_TEXT_TYPE_INFO_SUB_2, /**< Box contents 2-1 */
+ NOTIFICATION_TEXT_TYPE_INFO_3, /**< Box contents 3 */
+ NOTIFICATION_TEXT_TYPE_INFO_SUB_3, /**< Box contents 3-1 */
+ NOTIFICATION_TEXT_TYPE_GROUP_TITLE, /**< Group title */
+ NOTIFICATION_TEXT_TYPE_GROUP_CONTENT, /**< Group content */
+ NOTIFICATION_TEXT_TYPE_GROUP_CONTENT_FOR_DISPLAY_OPTION_IS_OFF, /**< Group content for content display option is off of the Settings */
+ NOTIFICATION_TEXT_TYPE_BUTTON_1, /**< Text on button 1 */
+ NOTIFICATION_TEXT_TYPE_BUTTON_2, /**< Text on button 2 */
+ NOTIFICATION_TEXT_TYPE_BUTTON_3, /**< Text on button 3 */
+ NOTIFICATION_TEXT_TYPE_BUTTON_4, /**< Text on button 4 */
+ NOTIFICATION_TEXT_TYPE_BUTTON_5, /**< Text on button 5 */
+ NOTIFICATION_TEXT_TYPE_BUTTON_6, /**< Text on button 6 */
+ NOTIFICATION_TEXT_TYPE_TEXT_INPUT_PLACEHOLDER, /**< Guide text on the message reply box(Since 3.0) */
+ NOTIFICATION_TEXT_TYPE_TEXT_INPUT_BUTTON, /**< Text on button the on message reply box(Since 3.0) */
NOTIFICATION_TEXT_TYPE_MAX,
} notification_text_type_e;
+
/**
* @brief Enumeration for image type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_image_type {
NOTIFICATION_IMAGE_TYPE_NONE = -1,
- NOTIFICATION_IMAGE_TYPE_ICON = 0,
- /**< Icon */
- NOTIFICATION_IMAGE_TYPE_ICON_FOR_INDICATOR,
- /**< Indicator icon */
- NOTIFICATION_IMAGE_TYPE_ICON_FOR_LOCK,
- /**< Lock screen icon */
- NOTIFICATION_IMAGE_TYPE_THUMBNAIL,
- /**< Thumbnail */
- NOTIFICATION_IMAGE_TYPE_THUMBNAIL_FOR_LOCK,
- /**< Lock screen thumbnail */
- NOTIFICATION_IMAGE_TYPE_ICON_SUB,
- /**< Icon */
- NOTIFICATION_IMAGE_TYPE_BACKGROUND,
- /**< image displayed on background */
- NOTIFICATION_IMAGE_TYPE_LIST_1,
- /**< Image for thumbnail list */
- NOTIFICATION_IMAGE_TYPE_LIST_2,
- /**< Image for thumbnail list */
- NOTIFICATION_IMAGE_TYPE_LIST_3,
- /**< Image for thumbnail list */
- NOTIFICATION_IMAGE_TYPE_LIST_4,
- /**< Image for thumbnail list */
- NOTIFICATION_IMAGE_TYPE_LIST_5,
- /**< Image for thumbnail list */
- NOTIFICATION_IMAGE_TYPE_BUTTON_1,
- /**< Image for button 1 */
- NOTIFICATION_IMAGE_TYPE_BUTTON_2,
- /**< Image for button 2 */
- NOTIFICATION_IMAGE_TYPE_BUTTON_3,
- /**< Image for button 3 */
- NOTIFICATION_IMAGE_TYPE_BUTTON_4,
- /**< Image for button 4 */
- NOTIFICATION_IMAGE_TYPE_BUTTON_5,
- /**< Image for button 5 */
- NOTIFICATION_IMAGE_TYPE_BUTTON_6,
- /**< Image for button 6 */
- NOTIFICATION_IMAGE_TYPE_TEXT_INPUT_BUTTON,
- /**< Image for message reply(Since 3.0) */
+ NOTIFICATION_IMAGE_TYPE_ICON = 0, /**< Icon */
+ NOTIFICATION_IMAGE_TYPE_ICON_FOR_INDICATOR, /**< Indicator icon */
+ NOTIFICATION_IMAGE_TYPE_ICON_FOR_LOCK, /**< Lock screen icon */
+ NOTIFICATION_IMAGE_TYPE_THUMBNAIL, /**< Thumbnail */
+ NOTIFICATION_IMAGE_TYPE_THUMBNAIL_FOR_LOCK, /**< Lock screen thumbnail */
+ NOTIFICATION_IMAGE_TYPE_ICON_SUB, /**< Icon */
+ NOTIFICATION_IMAGE_TYPE_BACKGROUND, /**< image displayed on background */
+ NOTIFICATION_IMAGE_TYPE_LIST_1, /**< Image for thumbnail list */
+ NOTIFICATION_IMAGE_TYPE_LIST_2, /**< Image for thumbnail list */
+ NOTIFICATION_IMAGE_TYPE_LIST_3, /**< Image for thumbnail list */
+ NOTIFICATION_IMAGE_TYPE_LIST_4, /**< Image for thumbnail list */
+ NOTIFICATION_IMAGE_TYPE_LIST_5, /**< Image for thumbnail list */
+ NOTIFICATION_IMAGE_TYPE_BUTTON_1, /**< Image for button 1 */
+ NOTIFICATION_IMAGE_TYPE_BUTTON_2, /**< Image for button 2 */
+ NOTIFICATION_IMAGE_TYPE_BUTTON_3, /**< Image for button 3 */
+ NOTIFICATION_IMAGE_TYPE_BUTTON_4, /**< Image for button 4 */
+ NOTIFICATION_IMAGE_TYPE_BUTTON_5, /**< Image for button 5 */
+ NOTIFICATION_IMAGE_TYPE_BUTTON_6, /**< Image for button 6 */
+ NOTIFICATION_IMAGE_TYPE_TEXT_INPUT_BUTTON, /**< Image for message reply(Since 3.0) */
NOTIFICATION_IMAGE_TYPE_MAX,
} notification_image_type_e;
+
/**
* @brief Enumeration for application execution type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_execute_type {
- NOTIFICATION_EXECUTE_TYPE_NONE = -1,
- /**< No operation */
- NOTIFICATION_EXECUTE_TYPE_RESPONDING = 0,
- /**< Responding action*/
- NOTIFICATION_EXECUTE_TYPE_SINGLE_LAUNCH,/**< Launching when notification data is single */
- NOTIFICATION_EXECUTE_TYPE_MULTI_LAUNCH,
- /**< Launching when notification data is grouping(multi) */
- NOTIFICATION_EXECUTE_TYPE_MAX,
- /**< Max flag */
+ NOTIFICATION_EXECUTE_TYPE_NONE = -1, /**< No operation */
+ NOTIFICATION_EXECUTE_TYPE_RESPONDING = 0, /**< Responding action*/
+ NOTIFICATION_EXECUTE_TYPE_SINGLE_LAUNCH, /**< Launching when notification data is single */
+ NOTIFICATION_EXECUTE_TYPE_MULTI_LAUNCH, /**< Launching when notification data is grouping(multi) */
+ NOTIFICATION_EXECUTE_TYPE_MAX, /**< Max flag */
} notification_execute_type_e;
+
/**
* @brief Enumeration for notification type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_type {
- NOTIFICATION_TYPE_NONE = -1,
- /**< None */
- NOTIFICATION_TYPE_NOTI = 0,
- /**< Notification type */
- NOTIFICATION_TYPE_ONGOING,
- /**< Ongoing type */
- NOTIFICATION_TYPE_MAX,
- /**< Max flag */
+ NOTIFICATION_TYPE_NONE = -1, /**< None */
+ NOTIFICATION_TYPE_NOTI = 0, /**< Notification type */
+ NOTIFICATION_TYPE_ONGOING, /**< Ongoing type */
+ NOTIFICATION_TYPE_MAX, /**< Max flag */
} notification_type_e;
+
/**
* @brief Enumeration for Group ID.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum _notification_group_id {
- NOTIFICATION_GROUP_ID_NONE = -1,/**< Not Grouping */
- NOTIFICATION_GROUP_ID_DEFAULT = 0,
- /**< Notification that has same title is grouping */
+ NOTIFICATION_GROUP_ID_NONE = -1, /**< Not Grouping */
+ NOTIFICATION_GROUP_ID_DEFAULT = 0, /**< Notification that has same title is grouping */
};
+
/**
* @brief Enumeration for Private ID.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum _notification_priv_id {
- NOTIFICATION_PRIV_ID_NONE = -1,
- /**< Internally set priv_id */
+ NOTIFICATION_PRIV_ID_NONE = -1, /**< Internally set priv_id */
};
+
/**
* @brief Enumeration for notification property.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
enum _notification_property {
- NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE = 0x00000001,
- /**< Display only SIM card inserted */
- NOTIFICATION_PROP_DISABLE_APP_LAUNCH = 0x00000002,
- /**< Disable application launch when it selected */
- NOTIFICATION_PROP_DISABLE_AUTO_DELETE = 0x00000004,
- /**< Disable auto delete when it selected */
- NOTIFICATION_PROP_LAUNCH_UG = 0x00000008,
- /**< Notification Tray should launch application using appsvc API (Deprecated since 2.3.1) */
- NOTIFICATION_PROP_DISABLE_TICKERNOTI = 0x00000010,
- /**< Use notification_set_display_applist API (Deprecated since 2.3.1) */
- NOTIFICATION_PROP_PERMANENT_DISPLAY = 0x00000020,
- /**< The notification will not be removed (Deprecated since 2.3.1) */
- NOTIFICATION_PROP_DISABLE_UPDATE_ON_INSERT = 0x00000040,/**< Disable update when it inserted. */
- NOTIFICATION_PROP_DISABLE_UPDATE_ON_DELETE = 0x00000080,/**< Disable update when it deleted. */
- NOTIFICATION_PROP_VOLATILE_DISPLAY = 0x00000100,/**< Deleted when device is rebooted eventhough NOTIFICATION_TYPE_NOTI type */
+ NOTIFICATION_PROP_DISPLAY_ONLY_SIMMODE = 0x00000001, /**< Display only SIM card inserted */
+ NOTIFICATION_PROP_DISABLE_APP_LAUNCH = 0x00000002, /**< Disable application launch when it selected */
+ NOTIFICATION_PROP_DISABLE_AUTO_DELETE = 0x00000004, /**< Disable auto delete when it selected */
+ NOTIFICATION_PROP_LAUNCH_UG = 0x00000008, /**< Notification Tray should launch application using appsvc API (Deprecated since 2.3.1) */
+ NOTIFICATION_PROP_DISABLE_TICKERNOTI = 0x00000010, /**< Use notification_set_display_applist API (Deprecated since 2.3.1) */
+ NOTIFICATION_PROP_PERMANENT_DISPLAY = 0x00000020, /**< The notification will not be removed (Deprecated since 2.3.1) */
+ NOTIFICATION_PROP_DISABLE_UPDATE_ON_INSERT = 0x00000040, /**< Disable update when it inserted. */
+ NOTIFICATION_PROP_DISABLE_UPDATE_ON_DELETE = 0x00000080, /**< Disable update when it deleted. */
+ NOTIFICATION_PROP_VOLATILE_DISPLAY = 0x00000100, /**< Deleted when device is rebooted eventhough NOTIFICATION_TYPE_NOTI type */
};
+
/**
* @brief Enumeration for display application list.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
NOTIFICATION_DISPLAY_APP_NOTIFICATION_TRAY = 0x00000001, /**< Notification Tray(Quickpanel) */
NOTIFICATION_DISPLAY_APP_TICKER = 0x00000002, /**< Ticker notification */
NOTIFICATION_DISPLAY_APP_LOCK = 0x00000004, /**< Lock screen */
- NOTIFICATION_DISPLAY_APP_INDICATOR = 0x00000008,/**< Indicator */
- NOTIFICATION_DISPLAY_APP_ACTIVE = 0x00000010,/**< Active notification */
+ NOTIFICATION_DISPLAY_APP_INDICATOR = 0x00000008, /**< Indicator */
+ NOTIFICATION_DISPLAY_APP_ACTIVE = 0x00000010, /**< Active notification */
NOTIFICATION_DISPLAY_APP_ALL = 0x0000000f, /**< All display application except active notification*/
};
+
/**
* @brief Enumeration for notification operation code.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_op_type {
- NOTIFICATION_OP_NONE = 0, /**< Default */
- NOTIFICATION_OP_INSERT = 1, /**< Notification inserted */
- NOTIFICATION_OP_UPDATE, /**< Notification updated */
- NOTIFICATION_OP_DELETE, /**< Notification deleted */
- NOTIFICATION_OP_DELETE_ALL, /**< Notifications deleted */
- NOTIFICATION_OP_REFRESH, /**< (Deprecated Since 2.3.1) */
- NOTIFICATION_OP_SERVICE_READY, /**< Notification service is ready */
+ NOTIFICATION_OP_NONE = 0, /**< Default */
+ NOTIFICATION_OP_INSERT = 1, /**< Notification inserted */
+ NOTIFICATION_OP_UPDATE, /**< Notification updated */
+ NOTIFICATION_OP_DELETE, /**< Notification deleted */
+ NOTIFICATION_OP_DELETE_ALL, /**< Notifications deleted */
+ NOTIFICATION_OP_REFRESH, /**< (Deprecated Since 2.3.1) */
+ NOTIFICATION_OP_SERVICE_READY, /**< Notification service is ready */
} notification_op_type_e;
+
/**
- * @brief Enumeration for notification operation data code
+ * @brief Enumeration for notification operation data code.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_op_data_type {
- NOTIFICATION_OP_DATA_MIN = 0, /**< Default */
- NOTIFICATION_OP_DATA_TYPE, /**< Operation type */
- NOTIFICATION_OP_DATA_PRIV_ID, /**< Private ID */
- NOTIFICATION_OP_DATA_NOTI, /**< Notification handler */
- NOTIFICATION_OP_DATA_EXTRA_INFO_1, /**< Reserved */
- NOTIFICATION_OP_DATA_EXTRA_INFO_2, /**< Reserved */
- NOTIFICATION_OP_DATA_MAX, /**< Max flag */
+ NOTIFICATION_OP_DATA_MIN = 0, /**< Default */
+ NOTIFICATION_OP_DATA_TYPE, /**< Operation type */
+ NOTIFICATION_OP_DATA_PRIV_ID, /**< Private ID */
+ NOTIFICATION_OP_DATA_NOTI, /**< Notification handler */
+ NOTIFICATION_OP_DATA_EXTRA_INFO_1, /**< Reserved */
+ NOTIFICATION_OP_DATA_EXTRA_INFO_2, /**< Reserved */
+ NOTIFICATION_OP_DATA_MAX, /**< Max flag */
} notification_op_data_type_e;
+
/**
* @brief Enumeration for notification count position in the text.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notifcation_count_pos_type {
- NOTIFICATION_COUNT_POS_NONE = -1,
- /**< Count data is not displaying in the text */
- NOTIFICATION_COUNT_POS_LEFT = 0,/**< Count data is displaying at the left of the text */
- NOTIFICATION_COUNT_POS_IN,
- /**< Count data is displaying in the text */
- NOTIFICATION_COUNT_POS_RIGHT,
- /**< Count data is displaying at the right of the text */
- NOTIFICATION_COUNT_POS_MAX,
- /**< Max flag */
+ NOTIFICATION_COUNT_POS_NONE = -1, /**< Count data is not displaying in the text */
+ NOTIFICATION_COUNT_POS_LEFT = 0, /**< Count data is displaying at the left of the text */
+ NOTIFICATION_COUNT_POS_IN, /**< Count data is displaying in the text */
+ NOTIFICATION_COUNT_POS_RIGHT, /**< Count data is displaying at the right of the text */
+ NOTIFICATION_COUNT_POS_MAX, /**< Max flag */
} notification_count_pos_type_e;
+
/**
* @brief Enumeration for notification variable parameter type.
* @since_tizen @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef enum _notification_variable_type {
- NOTIFICATION_VARIABLE_TYPE_NONE = -1,
- /**< Variable parameter type is NONE */
- NOTIFICATION_VARIABLE_TYPE_INT = 0,
- /**< Variable parameter type is int */
- NOTIFICATION_VARIABLE_TYPE_DOUBLE,
- /**< Variable parameter type is double */
- NOTIFICATION_VARIABLE_TYPE_STRING,
- /**< Variable parameter type is string */
- NOTIFICATION_VARIABLE_TYPE_COUNT,
- /**< Variable parameter type is count */
- NOTIFICATION_VARIABLE_TYPE_MAX,
- /**< Max flag */
+ NOTIFICATION_VARIABLE_TYPE_NONE = -1, /**< Variable parameter type is NONE */
+ NOTIFICATION_VARIABLE_TYPE_INT = 0, /**< Variable parameter type is int */
+ NOTIFICATION_VARIABLE_TYPE_DOUBLE, /**< Variable parameter type is double */
+ NOTIFICATION_VARIABLE_TYPE_STRING, /**< Variable parameter type is string */
+ NOTIFICATION_VARIABLE_TYPE_COUNT, /**< Variable parameter type is count */
+ NOTIFICATION_VARIABLE_TYPE_MAX, /**< Max flag */
} notification_variable_type_e;
+
/**
* @brief Notification handle.
* @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 @if WEARABLE 2.3.1 @elseif MOBILE 2.3 @endif
*/
typedef struct _notification_op {
- notification_op_type_e type; /**< Notification operation type */
- int priv_id; /**< private ID */
- int extra_info_1; /**< Reserved */
- int extra_info_2; /**< Reserved */
- notification_h noti; /**< Notification handler */
+ notification_op_type_e type; /**< Notification operation type */
+ int priv_id; /**< private ID */
+ int extra_info_1; /**< Reserved */
+ int extra_info_2; /**< Reserved */
+ notification_h noti; /**< Notification handler */
} notification_op;
+
/**
* @brief Enumeration for permission.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @since_tizen 3.0
*/
typedef enum notification_block_state {
- NOTIFICATION_BLOCK_STATE_ALLOWED = 0, /**< The app is allowed to post notifications */
- NOTIFICATION_BLOCK_STATE_BLOCKED, /**< The app is not allowed to post any notifications */
- NOTIFICATION_BLOCK_STATE_DO_NOT_DISTURB /**< User set do not disturb mode */
+ NOTIFICATION_BLOCK_STATE_ALLOWED = 0, /**< The app is allowed to post notifications */
+ NOTIFICATION_BLOCK_STATE_BLOCKED, /**< The app is not allowed to post any notifications */
+ NOTIFICATION_BLOCK_STATE_DO_NOT_DISTURB /**< User set do not disturb mode */
} notification_block_state_e;
/**
projects / platform / core / api / notification.git / commitdiff