Remove conditional statements for Mobile & Wearable profile 13/302713/2
authorKrishna Kant Jaju <krishna.jaju@samsung.com>
Tue, 12 Dec 2023 10:31:32 +0000 (16:01 +0530)
committerKrishna Kant Jaju <krishna.jaju@samsung.com>
Tue, 12 Dec 2023 10:41:02 +0000 (10:41 +0000)
Change-Id: I8ee75bb2a4af990f5f798a0d0a29ebe6ceb5f200
Signed-off-by: Krishna Kant Jaju <krishna.jaju@samsung.com>
include/push-service.h
include/push.h

index 63ee0a4..8a7fc37 100644 (file)
@@ -46,7 +46,7 @@ extern "C" {
 
 /**
  * @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 */
@@ -61,7 +61,7 @@ typedef enum {
 
 /**
  * @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 */
@@ -73,7 +73,7 @@ typedef enum {
 
 /**
  * @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 */
@@ -84,19 +84,19 @@ typedef enum {
 
 /**
  * @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.
@@ -110,7 +110,7 @@ typedef void (*push_service_state_cb)(
 
 /**
  * @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
@@ -122,7 +122,7 @@ typedef void (*push_service_notify_cb)(
 
 /**
  * @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
@@ -134,7 +134,7 @@ typedef void (*push_service_result_cb)(push_service_result_e result, const char
 
 /**
  * @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
@@ -166,7 +166,7 @@ int push_service_connect(const char *push_app_id,
 
 /**
  * @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
@@ -181,7 +181,7 @@ void push_service_disconnect(push_service_connection_h connection);
 
 /**
  * @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>
@@ -202,7 +202,7 @@ int push_service_register(push_service_connection_h connection,
 
 /**
  * @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>
@@ -228,7 +228,7 @@ int push_service_deregister(push_service_connection_h connection, push_service_r
  *          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
@@ -261,7 +261,7 @@ char *push_service_app_control_to_noti_data(app_control_h app_control, char *ope
  *          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
@@ -288,7 +288,7 @@ int push_service_app_control_to_notification(app_control_h app_control, char *op
 
 /**
  * @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
@@ -307,7 +307,7 @@ int push_service_get_notification_data(push_service_notification_h notification,
 
 /**
  * @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.
@@ -329,7 +329,7 @@ int push_service_get_notification_message(push_service_notification_h notificati
 
 /**
  * @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.
@@ -346,7 +346,7 @@ int push_service_get_notification_time(push_service_notification_h notification,
 
 /**
  * @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
@@ -366,7 +366,7 @@ int push_service_get_notification_sender(push_service_notification_h notificatio
 
 /**
  * @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
@@ -387,7 +387,7 @@ int push_service_get_notification_session_info(push_service_notification_h notif
 
 /**
  * @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
@@ -407,7 +407,7 @@ int push_service_get_notification_request_id(push_service_notification_h notific
 
 /**
  * @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,
@@ -427,7 +427,7 @@ int push_service_get_notification_type(push_service_notification_h notification,
  *          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
@@ -455,7 +455,7 @@ int push_service_get_unread_notification(push_service_connection_h connection,
  *          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,
@@ -473,7 +473,7 @@ int push_service_request_unread_notification(push_service_connection_h connectio
 
 /**
  * @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
@@ -490,7 +490,7 @@ int push_service_get_registration_id(push_service_connection_h connection, char
 
 /**
  * @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
index 01706aa..dd4c017 100644 (file)
@@ -36,7 +36,7 @@ extern "C" {
 
 /**
  * @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 */
@@ -51,7 +51,7 @@ typedef enum {
 
 /**
  * @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 */
@@ -63,7 +63,7 @@ typedef enum {
 
 /**
  * @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 */
@@ -79,13 +79,13 @@ typedef struct push_connection_s *push_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_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.
@@ -99,7 +99,7 @@ typedef void (*push_state_cb)(
 
 /**
  * @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
@@ -111,7 +111,7 @@ typedef void (*push_notify_cb)(
 
 /**
  * @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
@@ -123,7 +123,7 @@ typedef void (*push_result_cb)(push_result_e result, const char *msg, void *user
 
 /**
  * @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,
@@ -153,7 +153,7 @@ int push_connect(const char *push_app_id, push_state_cb state_callback,
 
 /**
  * @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.
@@ -164,7 +164,7 @@ void push_disconnect(push_connection_h connection);
 
 /**
  * @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
@@ -187,7 +187,7 @@ int push_register(push_connection_h connection, app_control_h app_control,
 
 /**
  * @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
@@ -255,7 +255,7 @@ int push_deregister_dbus_call_info(struct push_connection_s *conn, push_result_c
 
 /**
  * @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
@@ -274,7 +274,7 @@ int push_get_notification_data(push_notification_h notification, char **data);
 
 /**
  * @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
@@ -294,7 +294,7 @@ int push_get_notification_message(push_notification_h notification,
 
 /**
  * @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
@@ -314,7 +314,7 @@ int push_get_notification_time(push_notification_h notification, long long int *
 
 /**
  * @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
@@ -334,7 +334,7 @@ int push_get_notification_sender(push_notification_h notification,
 
 /**
  * @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
@@ -355,7 +355,7 @@ int push_get_notification_session_info(push_notification_h notification,
 
 /**
  * @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
@@ -375,7 +375,7 @@ int push_get_notification_request_id(push_notification_h notification,
 
 /**
  * @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
@@ -396,7 +396,7 @@ int push_get_notification_type(push_notification_h notification, int *type);
  *          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().
@@ -425,7 +425,7 @@ int push_get_unread_notification(push_connection_h connection,
  *          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
@@ -448,7 +448,7 @@ int push_request_unread_notification(push_connection_h connection);
                        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
@@ -472,7 +472,7 @@ int push_get_notification_using_token(const char *noti_token, push_notification_
 
 /**
  * @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
@@ -490,7 +490,7 @@ int push_get_registration_id(push_connection_h connection, char **reg_id);
 
 /**
  * @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