/**
* @brief The application control handle.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef struct app_control_s *app_control_h;
/**
* @brief Enumeration for the application control error.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
typedef enum {
APP_CONTROL_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
/**
* @brief Enumeration for the application control result.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @see app_control_enable_app_started_result_event()
*/
typedef enum {
- APP_CONTROL_RESULT_APP_STARTED = 1, /**< Callee application launched actually (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
+ APP_CONTROL_RESULT_APP_STARTED = 1, /**< Callee application launched actually (Since 2.4) */
APP_CONTROL_RESULT_SUCCEEDED = 0, /**< Operation succeeded */
APP_CONTROL_RESULT_FAILED = -1, /**< Operation failed by the callee */
APP_CONTROL_RESULT_CANCELED = -2, /**< Operation canceled by the platform */
/**
* @brief Enumeration for the application control launch mode.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
typedef enum {
APP_CONTROL_LAUNCH_MODE_SINGLE = 0, /**< Prefer to launch an application as single mode */
* @brief Definition for the app_control operation: An explicit launch for the homescreen application.
* @details Input: Nothing\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_MAIN "http://tizen.org/appcontrol/operation/main"
* @brief Definition for the app_control operation: An explicit launch for an application that excludes the homescreen application.
* @details Input: Nothing\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_DEFAULT "http://tizen.org/appcontrol/operation/default"
* @brief Definition for the app_control operation: Provides an editable access to the given data.
* @details Input: It depends on the application scenario or configuration.\n
* Output: It depends on the application scenario or configuration.\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_EDIT "http://tizen.org/appcontrol/operation/edit"
* @brief Definition for the app_control operation: Displays the data.
* @details Input: URI is usually used to inform the path to show. In some cases, some other data in extra can be used (for example, the VIEW operation for viewing the contact and calendar data).\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_VIEW "http://tizen.org/appcontrol/operation/view"
* @brief Definition for the app_control operation: Picks the item.
* @details Input: It depends on the application scenario or configuration.\n
* Output: APP_CONTROL_DATA_SELECTED in extra.\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_PICK "http://tizen.org/appcontrol/operation/pick"
* @brief Definition for the app_control operation: Creates the contents.
* @details Input: It depends on application scenario or configuration.\n
* Output: APP_CONTROL_DATA_SELECTED in extra.\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_CREATE_CONTENT "http://tizen.org/appcontrol/operation/create_content"
* @brief Definition for the app_control operation: Performs a call to someone.
* @details Input: URI is the number to be dialed. This is a mandatory field.\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/call
* @remarks When you request this operation, you must declare this privilege.
/**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #APP_CONTROL_OPERATION_SHARE instead.
+ * @deprecated Deprecated since 2.4. Use #APP_CONTROL_OPERATION_SHARE instead.
* @brief Definition for the app_control operation: Delivers some data to someone else.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_SEND "http://tizen.org/appcontrol/operation/send"
/**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #APP_CONTROL_OPERATION_SHARE_TEXT instead.
+ * @deprecated Deprecated since 2.4. Use #APP_CONTROL_OPERATION_SHARE_TEXT instead.
* @brief Definition for the app_control operation: Delivers text data to someone else.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_SEND_TEXT "http://tizen.org/appcontrol/operation/send_text"
* @brief Definition for the app_control operation: Shares an item with someone else.
* @details Input: URI is usually used to inform the path to share. In some cases, some other data in extra can be used (for example, the SHARE operation for sharing the contact data, the SHARE operation for sharing an item through a message and email applications).\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_SHARE "http://tizen.org/appcontrol/operation/share"
* @brief Definition for the app_control operation: Shares multiple items with someone else.
* @details Input: APP_CONTROL_DATA_PATH in extra is usually used to inform the data to share. In some cases, some other data in extra can be used (for example, the MULTI_SHARE operation for sharing the contact data).\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_MULTI_SHARE "http://tizen.org/appcontrol/operation/multi_share"
* @brief Definition for the app_control operation: Shares the text data with someone else.
* @details Input: APP_CONTROL_DATA_TEXT in extra is the text to share\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_SHARE_TEXT "http://tizen.org/appcontrol/operation/share_text"
* @brief Definition for the app_control operation: Dials a number. This shows a UI with the number to be dialed, allowing the user to explicitly initiate the call.
* @details Input: URI is the number to be dialed. If empty, show a UI without the number.\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_DIAL "http://tizen.org/appcontrol/operation/dial"
* @brief Definition for the app_control operation: Performs a search.
* @details Input: APP_CONTROL_DATA_TEXT in extra is the text to search for. If empty, show a search UI.\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_SEARCH "http://tizen.org/appcontrol/operation/search"
* @brief Definition for the app_control operation: Downloads the item.
* @details Input: It depends on the application scenario or configuration.\n
* Output: It depends on the application scenario or configuration.\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
- * @privilege %http://tizen.org/privilege/download (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
- * @remarks When you request this operation, you must declare this privilege. (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
+ * @privilege %http://tizen.org/privilege/download (Since 2.4)
+ * @remarks When you request this operation, you must declare this privilege. (Since 2.4)
*/
#define APP_CONTROL_OPERATION_DOWNLOAD "http://tizen.org/appcontrol/operation/download"
* @brief Definition for the app_control operation: Prints the content.
* @details Input: It depends on the application scenario or configuration.\n
* Output: It depends on the application scenario or configuration.\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_PRINT "http://tizen.org/appcontrol/operation/print"
* @brief Definition for the app_control operation: Composes a message.
* @details Input: It depends on the application scenario or configuration.\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_OPERATION_COMPOSE "http://tizen.org/appcontrol/operation/compose"
* @brief Definition for the app_control operation: Can be launched by an interested system-event.
* @details Input : URI and extras data defined in event module.\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @remarks This operation is for handling an event from the platform. This operation cannot be requested through the app_control_send_launch_request().
* @remarks Refer to the Launch-On-Event section of the event module.
*/
* @brief Definition for the app_control operation: Adds an item.
* @details Input: It depends on the application scenario or configuration.\n
* Output: It depends on the application scenario or configuration.\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_ADD "http://tizen.org/appcontrol/operation/add"
* @brief Definition for the app_control operation: Captures images by camera applications.
* @details Input: Nothing\n
* Output: APP_CONTROL_DATA_SELECTED in extra.\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_IMAGE_CAPTURE "http://tizen.org/appcontrol/operation/image_capture"
* @brief Definition for the app_control operation: Captures the videos by camera applications.
* @details Input: Nothing\n
* Output: APP_CONTROL_DATA_SELECTED in extra.\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_VIDEO_CAPTURE "http://tizen.org/appcontrol/operation/video_capture"
* @brief Definition for the app_control operation: Shows the settings to enable Bluetooth.
* @details Input: Nothing\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_SETTING_BT_ENABLE "http://tizen.org/appcontrol/operation/setting/bt_enable"
* @brief Definition for the app_control operation: Shows the settings to configure Bluetooth visibility.
* @details Input: Nothing\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_SETTING_BT_VISIBILITY "http://tizen.org/appcontrol/operation/setting/bt_visibility"
* @brief Definition for the app_control operation: Shows the settings to allow configuration of current location sources.
* @details Input: Nothing\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_SETTING_LOCATION "http://tizen.org/appcontrol/operation/setting/location"
* @brief Definition for the app_control operation: Shows the NFC settings.
* @details Input: APP_CONTROL_DATA_TYPE in extra (Since 3.0).\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @remarks Prior to Tizen 3.0, no input value was needed.
*/
#define APP_CONTROL_OPERATION_SETTING_NFC "http://tizen.org/appcontrol/operation/setting/nfc"
* @brief Definition for the app_control operation: Shows the system settings.
* @details Input: Nothing\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_SETTING "http://tizen.org/appcontrol/operation/setting"
* @brief Definition for the app_control operation: Shows the settings to allow configuration of Wi-Fi.
* @details Input: Nothing\n
* Output: Nothing\n
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_OPERATION_SETTING_WIFI "http://tizen.org/appcontrol/operation/setting/wifi"
* @brief Definition for the application control operation: Select the type of input method to receive an input from the user.
* @details Input: It depends on the application scenario or configuration.\n
* Output: APP_CONTROL_DATA_TEXT in extra.\n
- * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
+ * @since_tizen 3.0
*/
#define APP_CONTROL_OPERATION_GET_INPUT "http://tizen.org/appcontrol/operation/get_input"
/**
* @brief Definition for the app_control data: Subject.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_DATA_SUBJECT "http://tizen.org/appcontrol/data/subject"
/**
* @brief Definition for the app_control data: Recipients.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_DATA_TO "http://tizen.org/appcontrol/data/to"
/**
* @brief Definition for the app_control data: Email addresses that should be carbon copied.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_DATA_CC "http://tizen.org/appcontrol/data/cc"
/**
* @brief Definition for the app_control data: Email addresses that should be blind carbon copied.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_DATA_BCC "http://tizen.org/appcontrol/data/bcc"
/**
* @brief Definition for the app_control data: Text.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_DATA_TEXT "http://tizen.org/appcontrol/data/text"
/**
* @brief Definition for the app_control data: Title.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_DATA_TITLE "http://tizen.org/appcontrol/data/title"
/**
* @brief Definition for the app_control data: Selected items.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks Since Tizen 3.0, if all added paths with this key are under the caller application's data path which can be obtained by calling app_get_data_path() function, those will be shared to the callee application. Framework will grant a temporary permission to the callee application for those files and revoke it when the callee application is terminated. Paths should be regular files. The callee application can just read them. Note that the callee application doesn't have read permission of the directory that is obtained by caller's app_get_data_path(), you should open the file path with read only mode directly. For example, access() call to the file path will return error because access() needs the read permission of the directory. The callee application can call open() with O_RDONLY mode for the passed file path, because framework grants read permission to the passed file path.
*/
#define APP_CONTROL_DATA_SELECTED "http://tizen.org/appcontrol/data/selected"
/**
* @brief Definition for the app_control data: Paths of items.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, if all added paths with this key are under the caller application's data path which can be obtained by the calling app_get_data_path() function, those will be shared to the callee application. Framework will grant a temporary permission to the callee application for those files and revoke it when the callee application is terminated. Paths should be regular files. The callee application can just read them. Note that the callee application doesn't have read permission of the directory that is obtained by the caller's app_get_data_path(), you should open the file path with the read only mode directly. For example, access() call to the file path will return error because access() needs the read permission of the directory. The callee application can call open() with the O_RDONLY mode for the passed file path, because framework grants the read permission to the passed file path.
+ * @since_tizen 2.3
+ * @remarks Since Tizen 2.4, if all added paths with this key are under the caller application's data path which can be obtained by the calling app_get_data_path() function, those will be shared to the callee application. Framework will grant a temporary permission to the callee application for those files and revoke it when the callee application is terminated. Paths should be regular files. The callee application can just read them. Note that the callee application doesn't have read permission of the directory that is obtained by the caller's app_get_data_path(), you should open the file path with the read only mode directly. For example, access() call to the file path will return error because access() needs the read permission of the directory. The callee application can call open() with the O_RDONLY mode for the passed file path, because framework grants the read permission to the passed file path.
*/
#define APP_CONTROL_DATA_PATH "http://tizen.org/appcontrol/data/path"
/**
* @brief Definition for the app_control data: Selection mode ("single" or "multiple").
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*/
#define APP_CONTROL_DATA_SELECTION_MODE "http://tizen.org/appcontrol/data/selection_mode"
/**
* @brief Definition for the app_control data: All-day mode of the event ("true" or "false").
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_CALENDAR_ALL_DAY "http://tizen.org/appcontrol/data/calendar/all_day"
/**
* @brief Definition for the app_control data: Start time of the event (format: YYYY-MM-DD HH:MM:SS).
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_CALENDAR_START_TIME "http://tizen.org/appcontrol/data/calendar/start_time"
/**
* @brief Definition for the app_control data: End time of event (format: YYYY-MM-DD HH:MM:SS).
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_CALENDAR_END_TIME "http://tizen.org/appcontrol/data/calendar/end_time"
/**
* @brief Definition for the app_control data: Email addresses.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_EMAIL "http://tizen.org/appcontrol/data/email"
/**
* @brief Definition for the app_control data: Phone numbers.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_PHONE "http://tizen.org/appcontrol/data/phone"
/**
* @brief Definition for the app_control data: URLs.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_URL "http://tizen.org/appcontrol/data/url"
/**
* @brief Definition for the app_control data: IDs.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_ID "http://tizen.org/appcontrol/data/id"
/**
* @brief Definition for the app_control data: Type.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_TYPE "http://tizen.org/appcontrol/data/type"
/**
* @brief Definition for the app_control data: Total count.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_TOTAL_COUNT "http://tizen.org/appcontrol/data/total_count"
/**
* @brief Definition for the app_control data: Total size (unit : bytes).
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_TOTAL_SIZE "http://tizen.org/appcontrol/data/total_size"
/**
* @brief Definition for the app_control data: Name.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
*/
#define APP_CONTROL_DATA_NAME "http://tizen.org/appcontrol/data/name"
* "input_drawing" Launch the input method with the drawing type.
* "input_recording" Launch the input method with the voice recording type.
* input_reply, input_drawing and input_recording types are valid since tizen 4.0.
- * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
+ * @since_tizen 3.0
*/
#define APP_CONTROL_DATA_INPUT_TYPE "http://tizen.org/appcontrol/data/input_type"
/**
* @brief Definition for the app_control data: Sends the pre-input text such as "http://" in web.
- * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
+ * @since_tizen 3.0
*/
#define APP_CONTROL_DATA_INPUT_DEFAULT_TEXT "http://tizen.org/appcontrol/data/input_default_text"
/**
* @brief Definition for the app_control data: Sends the guide text to show the user such as "Input user name".
- * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
+ * @since_tizen 3.0
*/
#define APP_CONTROL_DATA_INPUT_GUIDE_TEXT "http://tizen.org/appcontrol/data/input_guide_text"
/**
* @brief Definition for the app_control data: Sends text to receive the result from smart reply.
- * @since_tizen @if WEARABLE 2.3.2 @elseif MOBILE 3.0 @endif
+ * @since_tizen 3.0
*/
#define APP_CONTROL_DATA_INPUT_PREDICTION_HINT "http://tizen.org/appcontrol/data/input_prediction_hint"
/**
* @brief Called when the reply of the launch request is delivered.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a request and @a reply must not be deallocated by the application.
*
* @param[in] request The app_control handle of the launch request that has been sent
* @param[in] result The result code of the launch request
* @param[in] user_data The user data passed from the callback registration function
* @pre When the callee replies to the launch request, this callback will be invoked.
- * @pre Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, if #APP_CONTROL_RESULT_APP_STARTED event is enabled,
+ * @pre Since 2.4, if #APP_CONTROL_RESULT_APP_STARTED event is enabled,
* this callback will also be invoked when the callee application actually launched.
* @see app_control_send_launch_request()
* @see app_control_reply_to_launch_request()
/**
* @brief Called to retrieve the extra data contained in the app_control.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a key must not be deallocated by the application.
*
* @param[in] app_control The app_control handle
/**
* @brief Called once for each matched application that can be launched to handle the given app_control request.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] appid The name of the application that can handle the launch request of the given app_control
/**
* @brief Creates an app_control handle.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a app_control must be released using app_control_destroy().
*
* @param[out] app_control The app_control handle to be newly created on success
/**
* @brief Destroys the app_control handle and releases all its resources.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @return @c 0 on success,
* @details The @a operation is the mandatory information for the launch request.
* If the operation is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
* If the operation is #APP_CONTROL_OPERATION_DEFAULT, the package information is mandatory to explicitly launch the application.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] operation The operation to be performed (if the @a operation is @c NULL, it clears the previous value)
/**
* @brief Gets the operation to be performed.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a operation must be released using free().
*
* @param[in] app_control The app_control handle
/**
* @brief Sets the URI of the data.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, if the parameter @a uri is started with '%file://' and it is a regular file in this application's data path which can be obtained by calling the app_get_data_path() function, it will be shared to the callee application. Framework will grant a temporary permission to the callee application for this file and revoke it when the callee application is terminated. The callee application can just read it.
+ * @since_tizen 2.3
+ * @remarks Since Tizen 2.4, if the parameter @a uri is started with '%file://' and it is a regular file in this application's data path which can be obtained by calling the app_get_data_path() function, it will be shared to the callee application. Framework will grant a temporary permission to the callee application for this file and revoke it when the callee application is terminated. The callee application can just read it.
*
* @param[in] app_control The app_control handle
* @param[in] uri The URI of the data this app_control is operating on (if the @a uri is @c NULL, it clears the previous value)
/**
* @brief Gets the URI of the data.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a uri must be released using free().
*
* @param[in] app_control The app_control handle
/**
* @brief Sets the explicit MIME type of the data.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] mime The explicit MIME type of the data this app_control is operating on (if the @a mime is @c NULL, it clears the previous value)
/**
* @brief Gets the explicit MIME type of the data.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a mime must be released using free().
*
* @param[in] app_control The app_control handle
/**
* @brief Sets the explicit category.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] category The explicit category (if the @a category is @c NULL, it clears the previous value)
/**
* @brief Gets the explicit category.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a category must be released using free().
*
* @param[in] app_control The app_control handle
/**
* @brief Sets the ID of the application to explicitly launch.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] app_id The ID of the application to explicitly launch (if the @a app_id is @c NULL, it clears the previous value)
/**
* @brief Gets the ID of the application to explicitly launch.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a app_id must be released with free().
*
* @param[in] app_control The app_control handle
/**
* @brief Adds extra data to the app_control.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The function replaces any existing value for the given key.
* @remarks The function returns #APP_CONTROL_ERROR_INVALID_PARAMETER if @a key or @a value is a zero-length string.
* @remarks The function returns #APP_CONTROL_ERROR_KEY_REJECTED if the application tries to use the same key with the system-defined key.
/**
* @brief Adds the extra data array to the app_control.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The function replaces any existing value for the given key.
* @remarks The function returns #APP_CONTROL_ERROR_INVALID_PARAMETER if @a key is a zero-length string.
* @remarks The function returns #APP_CONTROL_ERROR_KEY_REJECTED if the application tries to use the same key with the system-defined key.
/**
* @brief Removes the extra data from the app_control.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] key The name of the extra data
/**
* @brief Gets the extra data from the app_control.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a value must be released using free().
* @remarks The function returns #APP_CONTROL_ERROR_INVALID_DATA_TYPE if @a value is of array data type.
*
/**
* @brief Gets the extra data array from the app_control.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a value must be released using free().
* @remarks The function returns #APP_CONTROL_ERROR_INVALID_DATA_TYPE if @a value is not of array data type.
*
/**
* @brief Checks whether the extra data associated with the given @a key is of array data type.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] key The name of the extra data
* @details This function calls app_control_extra_data_cb() once for each key-value pair for extra data contained in app_control. \n
* If the app_control_extra_data_cb() callback function returns @c false, then iteration will be finished.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] callback The iteration callback function
/**
* @brief Retrieves all applications that can be launched to handle the given app_control request.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
*
* @param[in] app_control The app_control handle
* @param[in] callback The iteration callback function
* @details The operation is mandatory information for the launch request. \n
* If the operation is not specified, #APP_CONTROL_OPERATION_DEFAULT is used by default.
* If the operation is #APP_CONTROL_OPERATION_DEFAULT, the application ID is mandatory to explicitly launch the application.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch
* @remarks The function returns #APP_CONTROL_ERROR_LAUNCH_REJECTED if the operation value is #APP_CONTROL_OPERATION_LAUNCH_ON_EVENT which is only for handling the event from the platform or other application, refer to the @ref CAPI_EVENT_MODULE module.
- * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, the launch request of the service application over out of packages is restricted by the platform. Also, implicit launch requests are NOT delivered to service applications since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. To launch a service application, an explicit launch request with application ID given by the app_control_set_app_id() must be sent.
+ * @remarks Since Tizen 2.4, the launch request of the service application over out of packages is restricted by the platform. Also, implicit launch requests are NOT delivered to service applications since 2.4. To launch a service application, an explicit launch request with application ID given by the app_control_set_app_id() must be sent.
*
* @param[in] app_control The app_control handle
* @param[in] callback The callback function to be called when the reply is delivered
/**
* @brief Sends the terminate request to the application that is launched by app_control. This function is only effective for some applications that are provided by default for handling platform default app_controls. You are not allowed to terminate other general applications using this function.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this function can be used to terminate sub-applications which were launched as group mode by the caller application.
+ * @since_tizen 2.3
+ * @remarks Since Tizen 2.4, this function can be used to terminate sub-applications which were launched as group mode by the caller application.
* Once callee application is being terminated by this function, other applications which were launched by the callee application as a group mode will be terminated as well.
*
* @param[in] app_control The app_control handle
* @brief Replies to the launch request sent by the caller.
* @details If the caller application sent the launch request to receive the result, the callee application can return the result back to the caller.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The function is not allowed to send reply #APP_CONTROL_RESULT_APP_STARTED as @a result which is reserved for platform developers.
*
* @param[in] reply The app_control handle in which the results of the callee are contained
/**
* @brief Creates and returns a copy of the given app_control handle.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks A newly created app_control should be destroyed by calling the app_control_destroy() if it is no longer needed.
*
* @param[out] clone If successful, a newly created app_control handle will be returned
/**
* @brief Gets the application ID of the caller from the launch request.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a app_control must be the launch request from app_control_cb().
* @remarks This function returns #APP_CONTROL_ERROR_INVALID_PARAMETER if the given app_control is not the launch request.
* @remarks The @a id must be released using free().
/**
* @brief Checks whether the caller is requesting a reply from the launch request.
*
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
* @remarks The @a app_control must be the launch request from app_control_cb().
* @remarks This function returns #APP_CONTROL_ERROR_INVALID_PARAMETER if the given app_control is not the launch request.
*
* @brief Sets the launch mode of the application.
*
* @details This function allows the callee application to be launched as a group or as a single mode.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @remarks Although launch_mode were set as #APP_CONTROL_LAUNCH_MODE_GROUP, the callee application would be launched as a single mode if the manifest file of callee application defined the launch mode as "single".
* This function can just set the preference of the caller application to launch an application.
* @remarks Sub-applications which were launched as a group mode always have own process.
/**
* @brief Gets the launch mode of the application.
*
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @remarks Since Tizen 3.0, if launch mode is not set in the caller application control,
* the function returns the #APP_CONTROL_LAUNCH_MODE_SINGLE launch mode.
*
*
* @details The function allows to receive the #APP_CONTROL_RESULT_APP_STARTED event on\n
* application get launched by the app_control.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
* @remarks app_control_reply_cb() will be called on the #APP_CONTROL_RESULT_APP_STARTED event received.
*
* @param[in] app_control The app_control handle
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch
* @remarks The function returns #APP_CONTROL_ERROR_LAUNCH_REJECTED if the operation value is #APP_CONTROL_OPERATION_LAUNCH_ON_EVENT which is only for handling the event from the platform or other application, refer to the @ref CAPI_EVENT_MODULE Module.
- * @remarks The launch request of the service application over out of packages is restricted by the platform. Also, implicit launch requests are NOT delivered to service applications since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. To launch a service application, an explicit launch request with application ID given by the app_control_set_app_id() must be sent.
+ * @remarks The launch request of the service application over out of packages is restricted by the platform. Also, implicit launch requests are NOT delivered to service applications since 2.4. To launch a service application, an explicit launch request with application ID given by the app_control_set_app_id() must be sent.
*
* @param[in] app_control The app_control handle
* @param[in] result_cb The callback function to be called when the result is delivered
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.launch
* @remarks The function returns #APP_CONTROL_ERROR_LAUNCH_REJECTED if the operation value is #APP_CONTROL_OPERATION_LAUNCH_ON_EVENT, which is only for handling the event from the platform or other applications, refer to the @ref CAPI_EVENT_MODULE Module.
- * @remarks The platform does not allow launching service applications from packages other than the requesting application's package. Also, implicit launch requests are NOT delivered to service applications since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. To launch a service application, an explicit launch request with application ID set by app_control_set_app_id() must be sent.
+ * @remarks The platform does not allow launching service applications from packages other than the requesting application's package. Also, implicit launch requests are NOT delivered to service applications since 2.4. To launch a service application, an explicit launch request with application ID set by app_control_set_app_id() must be sent.
* @remarks If the callee application doesn't respond, the function returns a negative error value.
* @remarks The @a reply must be released using app_control_destroy().
*
projects / platform / core / api / app-control.git / commitdiff