/**
* @brief Enumerations of error codes for push API.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
PUSH_SERVICE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
/**
* @brief Enumeration of registration states.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
PUSH_SERVICE_STATE_REGISTERED, /**< Registered */
/**
* @brief Enumeration of result.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
PUSH_SERVICE_RESULT_SUCCESS, /**< Successful */
/**
* @brief Connection to the push service handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef struct push_connection_s *push_service_connection_h;
/**
* @brief Notification delivered from the push server handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef struct push_notification_s *push_service_notification_h;
/**
* @brief Called when the registration state is refreshed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks This callback will be invoked when the registration state is refreshed. \n
* If the registration or deregistration has succeeded, then this state callback must be called. \n
* In addition, the state can be changed if the push server deregisters the application.
/**
* @brief Called to handle a notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] noti A handle of the notification containing its payload\n
* The handle is available inside this callback only.
* @param[in] user_data The user data passed to this callback
/**
* @brief Called with the result of a registration/deregistration.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The registration/deregistration result
* @param[in] msg The result message from the push server,
* otherwise @c NULL
/**
* @brief Connects to the push service and sets callback functions.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/push
* @remarks If there is a connection between an application and the push service,\n
/**
* @brief. Closes the connection and releases all its resources
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks If you call this function in the push callback functions,\n
* it may cause your application to crash.\n
* The specific error code can be obtained using the get_last_result()\n
/**
* @brief Registers an application to the push server.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle to the push service
* @param[in] result_callback Result callback function
* @param[in] user_data User data to pass to <I>result_cb</I>
/**
* @brief Deregisters an application from the Push server.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] connection The connection handle to the push service
* @param[in] result_callback Result callback function
* @param[in] user_data User data to pass to <I>result_cb</I>
* the push daemon forcibly launches the app and delivers the\n
* notification to the app as a bundle. This function returns\n
* the payload data in the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/push
* @remarks This function must be called in the app control callback function.\n
* the push daemon forcibly launches the app and delivers the\n
* notification to the app as a bundle. This function returns\n
* the notification from the bundle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/push
* @remarks This function must be called in the app control callback function.\n
/**
* @brief Gets notification data sent by the server.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a data using free().
* @param[in] notification The notification handle
* @param[out] data The notification data\n
/**
* @brief Gets the notification message sent by the server.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The <I>msg</I> must be released with free().\n
* push_service_request_unread_notification() is\n
* preferred to this API.
/**
* @brief Gets the received time of the notification message.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] notification The notification handle
* @param[out] received_time The received time of the notification message \n
* The @a received_time is based on UTC.
/**
* @brief Gets the sender of the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a sender using free().
* @param[in] notification The notification handle
* @param[out] sender The sender\n
/**
* @brief Gets the session ID of the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a session_info using free().
* @param[in] notification The notification handle
* @param[out] session_info The session ID\n
/**
* @brief Gets the request ID assigned by the sender.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a request_id using free().
* @param[in] notification The notification handle
* @param[out] request_id The request ID\n
/**
* @brief. Gets the value in the type field of the notification
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] notification The notification handle
* @param[out] type The type value assigned by the sender
* @return @c 0 on success,
* This method can be called repeatedly until it returns <I>#PUSH_SERVICE_ERROR_NO_DATA</I> \n
* But, this method does NOT guarantee order and reliability of notification messages. \n
* Some notification messages can be dropped when the system message queue is full.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks It is recommended to use push_service_request_unread_notification().
* @remarks You must release @a noti using push_service_free_notification().
* @param[in] connection The connection handle to the push service
* will be called when these messages arrive. No need to call this method multiple\n
* times to receive multiple messages. This method does NOT guarantee order and\n
* reliability of notification messages.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks This method is preferred to push_service_get_unread_notification().
* @param[in] connection The connection handle to the push service
* @return @c 0 on success,
/**
* @brief Gets the registration ID in the <I>#PUSH_SERVICE_STATE_REGISTERED</I> state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks You must release @a reg_id using free().
* @param[in] connection The connection handle to the push service
* @param[out] reg_id The registration ID\n
/**
* @brief Frees the notification handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The specific error code can be obtained using the get_last_result()\n
* Error codes are described in the exception section.
* @param[in] noti The notification handle
/**
* @brief Enumeration of error codes for push API.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
PUSH_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
/**
* @brief Enumeration of registration states.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
PUSH_STATE_REGISTERED, /**< Registered */
/**
* @brief Enumeration of result.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
PUSH_RESULT_SUCCESS, /**< Successful */
/**
* @brief Notification delivered from the push server handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef struct push_notification_s *push_notification_h;
/**
* @brief Called when the registration state is refreshed.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks This callback will be invoked when the registration state is refreshed. \n
* If the registration or deregistration has succeeded, then this state callback must be called. \n
* In addition, the state can be changed if the push server deregisters the application.
/**
* @brief Called to handle a notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] notification A handle of the notification containing its payload \n
* The handle is available inside this callback only.
* @param[in] user_data The user data passed to this callback
/**
* @brief Called with the result of a registration/deregistration.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @param[in] result The registration/deregistration result
* @param[in] msg The result message from the push server,
* otherwise @c NULL
/**
* @brief Connects to the push service and sets callback functions.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/push
* @remarks If there is a connection between an application and the push service,
/**
* @brief Closes the connection and releases all its resources.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks If you call this function in the push callback functions,
* it may cause your application to crash.
/**
* @brief Registers an application to the push server.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @param[in] connection The connection handle to the push service
* @param[in] app_control An @ref CAPI_APP_CONTROL_MODULE handle to launch an application by\n
/**
* @brief Deregisters an application from the Push server.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @param[in] connection The connection handle to the push service
* @param[in] result_callback Result callback function
/**
* @brief Gets the payload data in the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks You must release @a data using free().
* @param[in] notification The notification handle
/**
* @brief Gets the message in the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks You must release @a msg using free().
* @param[in] notification The notification handle
/**
* @brief Gets the received time of the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @param[in] notification The notification handle
* @param[out] timestamp The timestamp information that the application server
/**
* @brief Gets the sender of the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks You must release @a sender using free().
* @param[in] notification The notification handle
/**
* @brief Gets the session ID of the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks You must release @a session_info using free().
* @param[in] notification The notification handle
/**
* @brief Gets the request ID assigned by the sender.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks You must release @a request_id using free().
* @param[in] notification The notification handle
/**
* @brief Gets the value in the type field of the notification
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @param[in] notification The notification handle
* @param[out] type The type value assigned by the sender
* This method can be called repeatedly until it returns #PUSH_ERROR_NO_DATA.\n
* However, this method does NOT guarantee order and reliability of notification messages.\n
* Some notification messages can be dropped when the system message queue is full.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks This method will be deprecated.
* @remarks You must release @a noti using push_free_notification().
* will be called when these messages arrive. No need to call this method multiple\n
* times to receive multiple messages. This method does NOT guarantee order and\n
* reliability of notification messages.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remark This method is preferred to push_get_unread_notification().
* @param[in] connection The connection handle to the push service
is generated and delivered to the application as a bundle.\n
Using this API with this token, the application can get\n
the notification.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/push
* @remark This function must be called in the app control callback function.\n
/**
* @brief Gets the registration ID in the @a #PUSH_STATE_REGISTERED state.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @remarks You must release @a reg_id using free().
* @param[in] connection The connection handle to the push service
/**
* @brief Frees the notification handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/push
* @param[in] noti The notification handle