typedef unsigned char bundle_raw;
/**
- * @brief App Control handle.
+ * @brief The application control handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef struct app_control_s *app_control_h;
/**
- * @brief Enumeration for App Control Error.
+ * @brief Enumeration for the application control error.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef enum {
/**
- * @brief Enumeration for App Control Result.
+ * @brief Enumeration for the application control result.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @see app_control_enable_app_started_result_event()
*/
/**
- * @brief Enumeration for App Control Launch Mode.
+ * @brief Enumeration for the application control launch mode.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
typedef enum {
/**
- * @brief Definition for the app_control operation: An explicit launch for a homescreen application.
+ * @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
/**
- * @brief Definition for the app_control operation: An explicit launch for an application that excludes a homescreen application.
+ * @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
/**
* @brief Definition for the app_control operation: Provides an editable access to the given data.
- * @details Input: It depends on application scenario/configuration.\n
- * Output: It depends on application scenario/configuration.\n
+ * @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
*/
#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 (e.g., VIEW operation for viewing Contact, Calendar data).\n
+ * @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
*/
/**
- * @brief Definition for the app_control operation: Picks item.
- * @details Input: It depends on application scenario/configuration.\n
- * Output: APP_CONTROL_DATA_SELECTED in Extra\n
+ * @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
*/
#define APP_CONTROL_OPERATION_PICK "http://tizen.org/appcontrol/operation/pick"
/**
- * @brief Definition for the app_control operation: Creates contents.
- * @details Input: It depends on application scenario/configuration.\n
- * Output: APP_CONTROL_DATA_SELECTED in Extra\n
+ * @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
*/
#define APP_CONTROL_OPERATION_CREATE_CONTENT "http://tizen.org/appcontrol/operation/create_content"
/**
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. 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
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #APP_CONTROL_OPERATION_SHARE instead.
*/
#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.
* @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
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. Use #APP_CONTROL_OPERATION_SHARE_TEXT instead.
*/
#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 (e.g., SHARE operation for sharing Contact data, SHARE operation for sharing an item through Message, Email applications).\n
- * Output: Nothing\n
+ * @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
*/
#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 (e.g., MULTI_SHARE opeation for sharing Contact data).\n
+ * @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
*/
/**
- * @brief Definition for the app_control operation: Shares text data with someone else.
- * @details Input: APP_CONTROL_DATA_TEXT in Extra is the text to share\n
+ * @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
*/
/**
* @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 number.\n
+ * @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
*/
/**
* @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
+ * @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
*/
/**
- * @brief Definition for the app_control operation: Downloads item.
- * @details Input: It depends on application scenario/configuration.\n
- * Output: It depends on application scenario/configuration.\n
+ * @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
* @privlevel public
* @privilege %http://tizen.org/privilege/download (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif)
/**
- * @brief Definition for the app_control operation: Prints content.
- * @details Input: It depends on application scenario/configuration.\n
- * Output: It depends on application scenario/configuration.\n
+ * @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
*/
#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 application scenario/configuration.\n
+ * @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
*/
/**
- * @brief Definition for the app_control operation: Can be launched by interested System-Event.
- * @details Input : URI and extras data defined in Event module.\n
+ * @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
- * @remarks This operation is for handling event from the platform. This operation cannot be requested through app_control_send_launch_request().
- * @remarks Refer to Launch-On-Event section of Event module.
+ * @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.
*/
#define APP_CONTROL_OPERATION_LAUNCH_ON_EVENT "http://tizen.org/appcontrol/operation/launch_on_event"
/**
* @brief Definition for the app_control operation: Adds an item.
- * @details Input: It depends on application scenario/configuration.\n
- * Output: It depends on application scenario/configuration.\n
+ * @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
*/
#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
+ * Output: APP_CONTROL_DATA_SELECTED in extra.\n
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_OPERATION_IMAGE_CAPTURE "http://tizen.org/appcontrol/operation/image_capture"
/**
- * @brief Definition for the app_control operation: Captures videos by camera applications.
+ * @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
+ * Output: APP_CONTROL_DATA_SELECTED in extra.\n
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_OPERATION_VIDEO_CAPTURE "http://tizen.org/appcontrol/operation/video_capture"
/**
- * @brief Definition for the app_control operation: Shows settings to enable Bluetooth.
+ * @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
/**
- * @brief Definition for the app_control operation: Shows settings to configure Bluetooth visibility.
+ * @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
/**
- * @brief Definition for the app_control operation: Shows settings to allow configuration of current location sources.
+ * @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
/**
- * @brief Definition for the app_control operation: Shows NFC settings.
- * @details Input: APP_CONTROL_DATA_TYPE in Extra (Since 3.0).\n
+ * @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
* @remarks Prior to Tizen 3.0, no input value was needed.
/**
- * @brief Definition for the app_control operation: Shows system settings.
+ * @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
/**
- * @brief Definition for the app_control operation: Shows settings to allow configuration of Wi-Fi.
+ * @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
/**
- * @brief Definition for the app control operation: Shows VPN service settings.
+ * @brief Definition for the application control operation: Shows the VPN service settings.
* @details Input: Nothing\n
* Output: Nothing\n
* @since_tizen 3.0
/**
- * @brief Definition for the app control operation: Select the type of input method to receive input from user.
- * @details Input: It depends on application scenario/configuration.\n
- * Output: APP_CONTROL_DATA_TEXT in Extra.\n
+ * @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
*/
#define APP_CONTROL_OPERATION_GET_INPUT "http://tizen.org/appcontrol/operation/get_input"
/**
- * @brief Definition for app_control data: Subject
+ * @brief Definition for the app_control data: Subject.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define APP_CONTROL_DATA_SUBJECT "http://tizen.org/appcontrol/data/subject"
/**
- * @brief Definition for app_control data: Recipients
+ * @brief Definition for the app_control data: Recipients.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define APP_CONTROL_DATA_TO "http://tizen.org/appcontrol/data/to"
/**
- * @brief Definition for app_control data: E-mail addresses that should be carbon copied.
+ * @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
*/
#define APP_CONTROL_DATA_CC "http://tizen.org/appcontrol/data/cc"
/**
- * @brief Definition for app_control data: E-mail addresses that should be blind carbon copied.
+ * @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
*/
#define APP_CONTROL_DATA_BCC "http://tizen.org/appcontrol/data/bcc"
/**
- * @brief Definition for app_control data: Text
+ * @brief Definition for the app_control data: Text.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define APP_CONTROL_DATA_TEXT "http://tizen.org/appcontrol/data/text"
/**
- * @brief Definition for app_control data: Title
+ * @brief Definition for the app_control data: Title.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define APP_CONTROL_DATA_TITLE "http://tizen.org/appcontrol/data/title"
/**
- * @brief Definition for app_control data: Selected items
+ * @brief Definition for the app_control data: Selected items.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @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.
*/
/**
- * @brief Definition for app_control data: Paths of items
+ * @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 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.
+ * @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.
*/
#define APP_CONTROL_DATA_PATH "http://tizen.org/appcontrol/data/path"
/**
- * @brief Definition for app_control data: Selection mode ("single" or "multiple")
+ * @brief Definition for the app_control data: Selection mode ("single" or "multiple").
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define APP_CONTROL_DATA_SELECTION_MODE "http://tizen.org/appcontrol/data/selection_mode"
/**
- * @brief Definition for app_control data: All-day mode of event ("true" or "false")
+ * @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
*/
#define APP_CONTROL_DATA_CALENDAR_ALL_DAY "http://tizen.org/appcontrol/data/calendar/all_day"
/**
- * @brief Definition for app_control data: Start time of event (format: YYYY-MM-DD HH:MM:SS)
+ * @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
*/
#define APP_CONTROL_DATA_CALENDAR_START_TIME "http://tizen.org/appcontrol/data/calendar/start_time"
/**
- * @brief Definition for app_control data: End time of event (format: YYYY-MM-DD HH:MM:SS)
+ * @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
*/
#define APP_CONTROL_DATA_CALENDAR_END_TIME "http://tizen.org/appcontrol/data/calendar/end_time"
/**
- * @brief Definition for app_control data: E-mail addresses
+ * @brief Definition for the app_control data: Email addresses.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_DATA_EMAIL "http://tizen.org/appcontrol/data/email"
/**
- * @brief Definition for app_control data: Phone numbers
+ * @brief Definition for the app_control data: Phone numbers.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_DATA_PHONE "http://tizen.org/appcontrol/data/phone"
/**
- * @brief Definition for app_control data: URLs
+ * @brief Definition for the app_control data: URLs.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_DATA_URL "http://tizen.org/appcontrol/data/url"
/**
- * @brief Definition for app_control data: IDs
+ * @brief Definition for the app_control data: IDs.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_DATA_ID "http://tizen.org/appcontrol/data/id"
/**
- * @brief Definition for app_control data: Type
+ * @brief Definition for the app_control data: Type.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 2.3.2 @endif
*/
#define APP_CONTROL_DATA_TYPE "http://tizen.org/appcontrol/data/type"
/**
- * @brief Definition for app_control data: Total count
+ * @brief Definition for the app_control data: Total count.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_DATA_TOTAL_COUNT "http://tizen.org/appcontrol/data/total_count"
/**
- * @brief Definition for app_control data: Total size (unit : bytes)
+ * @brief Definition for the app_control data: Total size (unit : bytes).
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_DATA_TOTAL_SIZE "http://tizen.org/appcontrol/data/total_size"
/**
- * @brief Definition for app_control data: Name
+ * @brief Definition for the app_control data: Name.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define APP_CONTROL_DATA_NAME "http://tizen.org/appcontrol/data/name"
/**
- * @brief Definition for app_control data: Location
+ * @brief Definition for the app_control data: Location.
* @since_tizen 3.0
*/
#define APP_CONTROL_DATA_LOCATION "http://tizen.org/appcontrol/data/location"
/**
- * @brief Definition for app_control data: Select the type of input method.
- * @details Type: "input_voice" Launch input method with voice type.
- * "input_emoticon" Launch input method with emoticon type.
- * "input_keyboard" Launch input method with keyboard type.
- * "input_reply" Launch input method with context based reply type.
- * "input_drawing" Launch input method with drawing type.
- * "input_recording" Launch input method with voice recording type.
+ * @brief Definition for the app_control data: Selects the type of the input method.
+ * @details Type: "input_voice" Launch the input method with the voice type.
+ * "input_emoticon" Launch the input method with the emoticon type.
+ * "input_keyboard" Launch the input method with the keyboard type.
+ * "input_reply" Launch the input method with the context based reply type.
+ * "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
*/
/**
- * @brief Definition for app_control data: Send the pre input text such as "http://" in web.
+ * @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
*/
#define APP_CONTROL_DATA_INPUT_DEFAULT_TEXT "http://tizen.org/appcontrol/data/input_default_text"
/**
- * @brief Definition for app_control data: Send guide text to show the user such as "Input user name".
+ * @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
*/
#define APP_CONTROL_DATA_INPUT_GUIDE_TEXT "http://tizen.org/appcontrol/data/input_guide_text"
/**
- * @brief Definition for app_control data: Send text to receive the result from smart reply.
+ * @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
*/
#define APP_CONTROL_DATA_INPUT_PREDICTION_HINT "http://tizen.org/appcontrol/data/input_prediction_hint"
/**
- * @brief Definition for app_control data: Send type to set return key type in keyboard input type.
- * @details Type: "Done" Set type with Done label.
- * "Send" Set type with Send label.
- * "Join" Set type with Join label.
- * "Login" Set type with Login label.
- * "Next" Set type with Next label.
- * "Sign-in" Set type with Sign-in label.
- * "Search" Set type with Search label.
- * "Go" Set type with Go label.
+ * @brief Definition for the app_control data: Sends type to set the return key type in the keyboard input type.
+ * @details Type: "Done" Set the type with Done label.
+ * "Send" Set the type with Send label.
+ * "Join" Set the type with Join label.
+ * "Login" Set the type with Login label.
+ * "Next" Set the type with Next label.
+ * "Sign-in" Set the type with Sign-in label.
+ * "Search" Set the type with Search label.
+ * "Go" Set the type with Go label.
* @since_tizen 4.0
*/
#define APP_CONTROL_DATA_INPUT_RETURNKEY_TYPE "http://tizen.org/appcontrol/data/input_returnkey_type"
/**
- * @brief Definition for app_control data: Send length value to set max text length in keyboard input type.
+ * @brief Definition for the app_control data: Sends the length value to set the max text length in the keyboard input type.
* @since_tizen 4.0
*/
#define APP_CONTROL_DATA_INPUT_MAX_TEXT_LENGTH "http://tizen.org/appcontrol/data/input_max_text_length"
/**
- * @brief Definition for app_control data: Receive the reply type from input method.
- * @details Type: "input_voice" Receive the result from voice input type.
- * "input_emoticon" Receive the result from emoticon input type.
- * "input_keyboard" Receive the result from keyboard input type.
- * "input_reply" Receive the result from reply input type.
- * "input_image" Receive the result from image input type.
- * "input_audio" Receive the result from audio input type.
+ * @brief Definition for the app_control data: Receives the reply type from the input method.
+ * @details Type: "input_voice" Receive the result from the voice input type.
+ * "input_emoticon" Receive the result from the emoticon input type.
+ * "input_keyboard" Receive the result from the keyboard input type.
+ * "input_reply" Receive the result from the reply input type.
+ * "input_image" Receive the result from the image input type.
+ * "input_audio" Receive the result from the audio input type.
* @since_tizen 4.0
*/
#define APP_CONTROL_DATA_INPUT_REPLY_TYPE "http://tizen.org/appcontrol/data/input_reply_type"
/**
- * @brief Definition for app_control data: Send widget instance id to widget setup app.
- * @details The value is the id of the widget instance.
+ * @brief Definition for the app_control data: Sends the widget instance ID to the widget setup application.
+ * @details The value is the ID of the widget instance.
* @since_tizen 4.0
*/
#define APP_CONTROL_DATA_WIDGET_INSTANCE_ID "http://tizen.org/appcontrol/data/widget_instance_id"
/**
- * @brief Definition for app_control data: Send widget content to widget setup app.
- * @details The value is the content info of the widget instance.
+ * @brief Definition for the app_control data: Sends the widget content to the widget setup application.
+ * @details The value is the content information of the widget instance.
* @since_tizen 4.0
*/
#define APP_CONTROL_DATA_WIDGET_CONTENT "http://tizen.org/appcontrol/data/widget_content"
/**
- * @brief Definition for app_control data: Send widget appid to widget setup app.
- * @details The value is the appid declared in the widget application manifest file.
+ * @brief Definition for the app_control data: Sends the widget application ID to the widget setup application.
+ * @details The value is the application ID declared in the widget application manifest file.
* @since_tizen 4.0
*/
#define APP_CONTROL_DATA_WIDGET_APP_ID "http://tizen.org/appcontrol/data/widget_app_id"
* @param[in] request The app_control handle of the launch request that has been sent
* @param[in] reply The app_control handle in which the results of the callee are contained
* @param[in] result The result code of the launch request
- * @param[in] user_data The user data passed from the callback registration function
+ * @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,
- * this callback will also be invoked when the callee app actually launched.
+ * 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()
* @see app_control_enable_app_started_result_event()
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The @a key must not be deallocated by the application.
- * @param[in] app_control The app_control handle
+ * @param[in] app_control The app_control handle
* @param[in] key The key of the value contained in the app_control
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
- * @pre app_control_foreach_extra_data() will invoke this callback.
- * @see app_control_foreach_extra_data()
+ * @pre app_control_foreach_extra_data() will invoke this callback.
+ * @see app_control_foreach_extra_data()
*/
typedef bool (*app_control_extra_data_cb)(app_control_h app_control, const char *key, void *user_data);
* @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
- * @param[in] app_control The app_control handle
+ * @param[in] app_control The app_control handle
* @param[in] package The package name of the application that can handle the launch request of the given app_control
* @param[in] user_data The user data passed from the foreach function
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
- * @pre app_control_foreach_app_matched() will invoke this callback.
+ * @pre app_control_foreach_app_matched() will invoke this callback.
* @see app_control_foreach_app_matched()
*/
typedef bool (*app_control_app_matched_cb)(app_control_h app_control, const char *appid, void *user_data);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_destroy()
+ * @see app_control_destroy()
*/
int app_control_create(app_control_h *app_control);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_create()
+ * @see app_control_create()
*/
int app_control_destroy(app_control_h app_control);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_set_operation()
+ * @see app_control_set_operation()
*/
int app_control_get_operation(app_control_h app_control, char **operation);
* @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 'uri' is started with 'file://' and it is a regular file in this application's data path which can be obtained by calling 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.
+ * @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.
* @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)
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
- * @see app_control_get_uri()
+ * @see app_control_get_uri()
*/
int app_control_set_uri(app_control_h app_control, const char *uri);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_set_uri()
+ * @see app_control_set_uri()
*/
int app_control_get_uri(app_control_h app_control, char **uri);
* otherwise a negative error value
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
- * @see app_control_get_mime()
+ * @see app_control_get_mime()
*/
int app_control_set_mime(app_control_h app_control, const char *mime);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_set_mime()
+ * @see app_control_set_mime()
*/
int app_control_get_mime(app_control_h app_control, char **mime);
* otherwise a negative error value
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
- * @see app_control_get_category()
+ * @see app_control_get_category()
*/
int app_control_set_category(app_control_h app_control, const char *category);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_set_category()
+ * @see app_control_set_category()
*/
int app_control_get_category(app_control_h app_control, char **category);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_get_app_id()
+ * @see app_control_get_app_id()
*/
int app_control_set_app_id(app_control_h app_control, const char *app_id);
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_set_app_id()
+ * @see app_control_set_app_id()
*/
int app_control_get_app_id(app_control_h app_control, char **app_id);
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @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 system-defined key.
+ * @remarks The function returns #APP_CONTROL_ERROR_KEY_REJECTED if the application tries to use the same key with the system-defined key.
* @param[in] app_control The app_control handle
* @param[in] key The name of the extra data
* @param[in] value The value associated with the given key
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @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 system-defined key.
+ * @remarks The function returns #APP_CONTROL_ERROR_KEY_REJECTED if the application tries to use the same key with the system-defined key.
* @param[in] app_control The app_control handle
* @param[in] key The name of the extra data
* @param[in] value The array value associated with the given key
* 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
- * @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 @a Event 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 app_control_set_app_id() MUST be sent.
+ * @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 @a Event 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.
* @param[in] app_control The app_control handle
* @param[in] callback The callback function to be called when the reply is delivered
* @param[in] user_data The user data to be passed to the callback function
* @retval #APP_CONTROL_ERROR_LAUNCH_FAILED Failed to launch the application
* @retval #APP_CONTROL_ERROR_TIMED_OUT Failed due to timeout. The application that handles @a app_control may be busy
* @retval #APP_CONTROL_ERROR_PERMISSION_DENIED Permission denied
- * @post If the launch request is sent for the result, the result will come back through app_control_reply_cb() from the callee application. Additional replies may be delivered on app_control_enable_app_started_result_event() called.
+ * @post If the launch request is sent for the result, the result will come back through the app_control_reply_cb() from the callee application. Additional replies may be delivered on the app_control_enable_app_started_result_event() called.
* @see app_control_reply_to_launch_request()
* @see app_control_reply_cb()
* @see app_control_enable_app_started_result_event()
/**
* @brief Sends the terminate request to the application that is launched by app_control. This API 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 API.
*
- * @remarks Since Tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this API can be used to terminate sub-applications which were launched as group mode by caller application.
- * Once callee application is being terminated by this API, other applications which were launched by callee application as group mode will be terminated as well.
- *
* @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 API 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 API, 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
* @return @c 0 on success,
* otherwise a negative error value
* @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
* @param[in] request The app_control handle sent by the caller
- * @param[in] result The result code of the launch request
+ * @param[in] result The result code of the launch request
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_CONTROL_ERROR_NONE Successful
* @brief Creates and returns a copy of the given app_control handle.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks A newly created app_control should be destroyed by calling app_control_destroy() if it is no longer needed.
+ * @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
* @param[in] app_control The app_control handle
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_CONTROL_ERROR_OUT_OF_MEMORY Out of memory
- * @see app_control_destroy()
+ * @see app_control_destroy()
*/
int app_control_clone(app_control_h *clone, app_control_h app_control);
/**
* @brief Sets the launch mode of the application.
*
- * @details This function allows callee application to be launched as group or single mode.
- * @remarks Although launch_mode were set as #APP_CONTROL_LAUNCH_MODE_GROUP, callee application would be launched as single mode if the manifest file of callee application defined the launch mode as "single".
- * This function can just set the preference of caller application to launch an application.
- * @remarks Sub-applications which were launched as group mode always have own process.
- *
+ * @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
+ * @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.
+ *
* @param[in] app_control The app_control handle
- * @param[in] mode The launch mode of app
- * @return 0 on success, otherwise a negative error value
+ * @param[in] mode The launch mode of the application
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @see app_control_set_launch_mode()
/**
* @brief Gets the launch mode of the application.
*
- * @remarks Since Tizen 3.0, if launch mode not set in the caller app control,
- * the function returns #APP_CONTROL_LAUNCH_MODE_SINGLE launch mode.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @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.
* @param[in] app_control The app_control handle
- * @param[out] mode The launch mode of app
- * @return 0 on success, otherwise a negative error value
+ * @param[out] mode The launch mode of the application
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
- * @see app_control_get_launch_mode()
+ * @see app_control_get_launch_mode()
* @see app_control_launch_mode_e
*/
int app_control_get_launch_mode(app_control_h app_control,
app_control_launch_mode_e *mode);
/**
- * @brief Enables additional launch result event on launch request.
+ * @brief Enables an additional launch result event on the launch request.
*
- * @details The function allows to receive #APP_CONTROL_RESULT_APP_STARTED event on\n
- * application get launched by app_control.
- * @remarks app_control_reply_cb() will be called on APP_CONTROL_RESULT_APP_STARTED event received.
+ * @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
+ * @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
- * @return 0 on success, otherwise a negative error value
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #APP_CONTROL_ERROR_NONE Successful
* @retval #APP_CONTROL_ERROR_INVALID_PARAMETER Invalid parameter
* @see app_control_send_launch_request()
projects / platform / core / api / app-control.git / commitdiff