Tizen Native API
Functions | Typedefs | Defines
App Control
Application

Functions

int app_control_create (app_control_h *app_control)
 Creates an app_control handle.
int app_control_destroy (app_control_h app_control)
 Destroys the app_control handle and releases all its resources.
int app_control_set_operation (app_control_h app_control, const char *operation)
 Sets the operation to be performed.
int app_control_get_operation (app_control_h app_control, char **operation)
 Gets the operation to be performed.
int app_control_set_uri (app_control_h app_control, const char *uri)
 Sets the URI of the data.
int app_control_get_uri (app_control_h app_control, char **uri)
 Gets the URI of the data.
int app_control_set_mime (app_control_h app_control, const char *mime)
 Sets the explicit MIME type of the data.
int app_control_get_mime (app_control_h app_control, char **mime)
 Gets the explicit MIME type of the data.
int app_control_set_category (app_control_h app_control, const char *category)
 Sets the explicit category.
int app_control_get_category (app_control_h app_control, char **category)
 Gets the explicit category.
int app_control_set_app_id (app_control_h app_control, const char *app_id)
 Sets the ID of the application to explicitly launch.
int app_control_get_app_id (app_control_h app_control, char **app_id)
 Gets the ID of the application to explicitly launch.
int app_control_add_extra_data (app_control_h app_control, const char *key, const char *value)
 Adds extra data to the app_control.
int app_control_add_extra_data_array (app_control_h app_control, const char *key, const char *value[], int length)
 Adds the extra data array to the app_control.
int app_control_remove_extra_data (app_control_h app_control, const char *key)
 Removes the extra data from the app_control.
int app_control_get_extra_data (app_control_h app_control, const char *key, char **value)
 Gets the extra data from the app_control.
int app_control_get_extra_data_array (app_control_h app_control, const char *key, char ***value, int *length)
 Gets the extra data array from the app_control.
int app_control_is_extra_data_array (app_control_h app_control, const char *key, bool *array)
 Checks whether the extra data associated with the given key is of array data type.
int app_control_foreach_extra_data (app_control_h app_control, app_control_extra_data_cb callback, void *user_data)
 Retrieves all extra data contained in app_control.
int app_control_foreach_app_matched (app_control_h app_control, app_control_app_matched_cb callback, void *user_data)
 Retrieves all applications that can be launched to handle the given app_control request.
int app_control_send_launch_request (app_control_h app_control, app_control_reply_cb callback, void *user_data)
 Sends the launch request.
int app_control_send_terminate_request (app_control_h app_control)
 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.
int app_control_reply_to_launch_request (app_control_h reply, app_control_h request, app_control_result_e result)
 Replies to the launch request sent by the caller.
int app_control_clone (app_control_h *clone, app_control_h app_control)
 Creates and returns a copy of the given app_control handle.
int app_control_get_caller (app_control_h app_control, char **id)
 Gets the application ID of the caller from the launch request.
int app_control_is_reply_requested (app_control_h app_control, bool *requested)
 Checks whether the caller is requesting a reply from the launch request.
int app_control_set_launch_mode (app_control_h app_control, app_control_launch_mode_e mode)
 Sets the launch mode of the application.
int app_control_get_launch_mode (app_control_h app_control, app_control_launch_mode_e *mode)
 Gets the launch mode of the application.
int app_control_enable_app_started_result_event (app_control_h app_control)
 Enables additional launch result event on launch request.

Typedefs

typedef struct app_control_s * app_control_h
 App Control handle.
typedef void(* app_control_reply_cb )(app_control_h request, app_control_h reply, app_control_result_e result, void *user_data)
 Called when the reply of the launch request is delivered.
typedef bool(* app_control_extra_data_cb )(app_control_h app_control, const char *key, void *user_data)
 Called to retrieve the extra data contained in the app_control.
typedef bool(* app_control_app_matched_cb )(app_control_h app_control, const char *appid, void *user_data)
 Called once for each matched application that can be launched to handle the given app_control request.

Defines

#define APP_CONTROL_OPERATION_MAIN   "http://tizen.org/appcontrol/operation/main"
 Definition for the app_control operation: An explicit launch for a homescreen application.
#define APP_CONTROL_OPERATION_DEFAULT   "http://tizen.org/appcontrol/operation/default"
 Definition for the app_control operation: An explicit launch for an application that excludes a homescreen application.
#define APP_CONTROL_OPERATION_EDIT   "http://tizen.org/appcontrol/operation/edit"
 Definition for the app_control operation: Provides an editable access to the given data.
#define APP_CONTROL_OPERATION_VIEW   "http://tizen.org/appcontrol/operation/view"
 Definition for the app_control operation: Displays the data.
#define APP_CONTROL_OPERATION_PICK   "http://tizen.org/appcontrol/operation/pick"
 Definition for the app_control operation: Picks items.
#define APP_CONTROL_OPERATION_CREATE_CONTENT   "http://tizen.org/appcontrol/operation/create_content"
 Definition for the app_control operation: Creates contents.
#define APP_CONTROL_OPERATION_CALL   "http://tizen.org/appcontrol/operation/call"
 Definition for the app_control operation: Performs a call to someone.
#define APP_CONTROL_OPERATION_SEND   "http://tizen.org/appcontrol/operation/send"
 Definition for the app_control operation: Delivers some data to someone else.
#define APP_CONTROL_OPERATION_SEND_TEXT   "http://tizen.org/appcontrol/operation/send_text"
 Definition for the app_control operation: Delivers text data to someone else.
#define APP_CONTROL_OPERATION_SHARE   "http://tizen.org/appcontrol/operation/share"
 Definition for the app_control operation: Shares an item with someone else.
#define APP_CONTROL_OPERATION_MULTI_SHARE   "http://tizen.org/appcontrol/operation/multi_share"
 Definition for the app_control operation: Shares multiple items with someone else.
#define APP_CONTROL_OPERATION_SHARE_TEXT   "http://tizen.org/appcontrol/operation/share_text"
 Definition for the app_control operation: Shares text data with someone else.
#define APP_CONTROL_OPERATION_DIAL   "http://tizen.org/appcontrol/operation/dial"
 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.
#define APP_CONTROL_OPERATION_SEARCH   "http://tizen.org/appcontrol/operation/search"
 Definition for the app_control operation: Performs a search.
#define APP_CONTROL_OPERATION_DOWNLOAD   "http://tizen.org/appcontrol/operation/download"
 Definition for the app_control operation: Downloads items.
#define APP_CONTROL_OPERATION_PRINT   "http://tizen.org/appcontrol/operation/print"
 Definition for the app_control operation: Prints contents.
#define APP_CONTROL_OPERATION_COMPOSE   "http://tizen.org/appcontrol/operation/compose"
 Definition for the app_control operation: Composes a message.
#define APP_CONTROL_OPERATION_LAUNCH_ON_EVENT   "http://tizen.org/appcontrol/operation/launch_on_event"
 Definition for the app_control operation: Can be launched by interested System-Event.
#define APP_CONTROL_OPERATION_ADD   "http://tizen.org/appcontrol/operation/add"
 Definition for the app_control operation: Adds an item.
#define APP_CONTROL_OPERATION_IMAGE_CAPTURE   "http://tizen.org/appcontrol/operation/image_capture"
 Definition for the app_control operation: Captures images by camera applications.
#define APP_CONTROL_OPERATION_VIDEO_CAPTURE   "http://tizen.org/appcontrol/operation/video_capture"
 Definition for the app_control operation: Captures videos by camera applications.
#define APP_CONTROL_OPERATION_SETTING_BT_ENABLE   "http://tizen.org/appcontrol/operation/setting/bt_enable"
 Definition for the app_control operation: Shows settings to enable Bluetooth.
#define APP_CONTROL_OPERATION_SETTING_BT_VISIBILITY   "http://tizen.org/appcontrol/operation/setting/bt_visibility"
 Definition for the app_control operation: Shows settings to configure Bluetooth visibility.
#define APP_CONTROL_OPERATION_SETTING_LOCATION   "http://tizen.org/appcontrol/operation/setting/location"
 Definition for the app_control operation: Shows settings to allow configuration of current location sources.
#define APP_CONTROL_OPERATION_SETTING_NFC   "http://tizen.org/appcontrol/operation/setting/nfc"
 Definition for the app_control operation: Shows NFC settings.
#define APP_CONTROL_OPERATION_SETTING   "http://tizen.org/appcontrol/operation/setting"
 Definition for the app_control operation: Shows system settings.
#define APP_CONTROL_OPERATION_SETTING_WIFI   "http://tizen.org/appcontrol/operation/setting/wifi"
 Definition for the app_control operation: Shows settings to allow configuration of Wi-Fi.
#define APP_CONTROL_DATA_SUBJECT   "http://tizen.org/appcontrol/data/subject"
 Definition for app_control data: Subject.
#define APP_CONTROL_DATA_TO   "http://tizen.org/appcontrol/data/to"
 Definition for app_control data: Recipients.
#define APP_CONTROL_DATA_CC   "http://tizen.org/appcontrol/data/cc"
 Definition for app_control data: E-mail addresses that should be carbon copied.
#define APP_CONTROL_DATA_BCC   "http://tizen.org/appcontrol/data/bcc"
 Definition for app_control data: E-mail addresses that should be blind carbon copied.
#define APP_CONTROL_DATA_TEXT   "http://tizen.org/appcontrol/data/text"
 Definition for app_control data: Text.
#define APP_CONTROL_DATA_TITLE   "http://tizen.org/appcontrol/data/title"
 Definition for app_control data: Title.
#define APP_CONTROL_DATA_SELECTED   "http://tizen.org/appcontrol/data/selected"
 Definition for app_control data: Selected items.
#define APP_CONTROL_DATA_PATH   "http://tizen.org/appcontrol/data/path"
 Definition for app_control data: Paths of items.
#define APP_CONTROL_DATA_SELECTION_MODE   "http://tizen.org/appcontrol/data/selection_mode"
 Definition for app_control data: Selection mode. ("single" or "multiple")
#define APP_CONTROL_DATA_CALENDAR_ALL_DAY   "http://tizen.org/appcontrol/data/calendar/all_day"
 Definition for app_control data: All-day mode of event ("true" or "false")
#define APP_CONTROL_DATA_CALENDAR_START_TIME   "http://tizen.org/appcontrol/data/calendar/start_time"
 Definition for app_control data: Start time of event (format: YYYY-MM-DD HH:MM:SS)
#define APP_CONTROL_DATA_CALENDAR_END_TIME   "http://tizen.org/appcontrol/data/calendar/end_time"
 Definition for app_control data: End time of event (format: YYYY-MM-DD HH:MM:SS)
#define APP_CONTROL_DATA_EMAIL   "http://tizen.org/appcontrol/data/email"
 Definition for app_control data: E-mail addresses.
#define APP_CONTROL_DATA_PHONE   "http://tizen.org/appcontrol/data/phone"
 Definition for app_control data: Phone numbers.
#define APP_CONTROL_DATA_URL   "http://tizen.org/appcontrol/data/url"
 Definition for app_control data: URLs.
#define APP_CONTROL_DATA_ID   "http://tizen.org/appcontrol/data/id"
 Definition for app_control data: IDs.
#define APP_CONTROL_DATA_TYPE   "http://tizen.org/appcontrol/data/type"
 Definition for app_control data: Type.
#define APP_CONTROL_DATA_TOTAL_COUNT   "http://tizen.org/appcontrol/data/total_count"
 Definition for app_control data: Total count.
#define APP_CONTROL_DATA_TOTAL_SIZE   "http://tizen.org/appcontrol/data/total_size"
 Definition for app_control data: Total size (unit : bytes)
#define APP_CONTROL_DATA_NAME   "http://tizen.org/appcontrol/data/name"
 Definition for app_control data: Name.

The App Control API provides functions to launch other applications.

Required Header

#include <app_control.h>

Overview

Platform Application Controls

Define Documentation

#define APP_CONTROL_DATA_BCC   "http://tizen.org/appcontrol/data/bcc"

Definition for app_control data: E-mail addresses that should be blind carbon copied.

Since :
2.3
#define APP_CONTROL_DATA_CALENDAR_ALL_DAY   "http://tizen.org/appcontrol/data/calendar/all_day"

Definition for app_control data: All-day mode of event ("true" or "false")

Since :
2.4
#define APP_CONTROL_DATA_CALENDAR_END_TIME   "http://tizen.org/appcontrol/data/calendar/end_time"

Definition for app_control data: End time of event (format: YYYY-MM-DD HH:MM:SS)

Since :
2.4
#define APP_CONTROL_DATA_CALENDAR_START_TIME   "http://tizen.org/appcontrol/data/calendar/start_time"

Definition for app_control data: Start time of event (format: YYYY-MM-DD HH:MM:SS)

Since :
2.4
#define APP_CONTROL_DATA_CC   "http://tizen.org/appcontrol/data/cc"

Definition for app_control data: E-mail addresses that should be carbon copied.

Since :
2.3
#define APP_CONTROL_DATA_EMAIL   "http://tizen.org/appcontrol/data/email"

Definition for app_control data: E-mail addresses.

Since :
2.4
#define APP_CONTROL_DATA_ID   "http://tizen.org/appcontrol/data/id"

Definition for app_control data: IDs.

Since :
2.4
#define APP_CONTROL_DATA_NAME   "http://tizen.org/appcontrol/data/name"

Definition for app_control data: Name.

Since :
2.4
#define APP_CONTROL_DATA_PATH   "http://tizen.org/appcontrol/data/path"

Definition for app_control data: Paths of items.

Since :
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 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.
#define APP_CONTROL_DATA_PHONE   "http://tizen.org/appcontrol/data/phone"

Definition for app_control data: Phone numbers.

Since :
2.4
#define APP_CONTROL_DATA_SELECTED   "http://tizen.org/appcontrol/data/selected"

Definition for app_control data: Selected items.

Since :
2.3
#define APP_CONTROL_DATA_SELECTION_MODE   "http://tizen.org/appcontrol/data/selection_mode"

Definition for app_control data: Selection mode. ("single" or "multiple")

Since :
2.3
#define APP_CONTROL_DATA_SUBJECT   "http://tizen.org/appcontrol/data/subject"

Definition for app_control data: Subject.

Since :
2.3
#define APP_CONTROL_DATA_TEXT   "http://tizen.org/appcontrol/data/text"

Definition for app_control data: Text.

Since :
2.3
#define APP_CONTROL_DATA_TITLE   "http://tizen.org/appcontrol/data/title"

Definition for app_control data: Title.

Since :
2.3
#define APP_CONTROL_DATA_TO   "http://tizen.org/appcontrol/data/to"

Definition for app_control data: Recipients.

Since :
2.3
#define APP_CONTROL_DATA_TOTAL_COUNT   "http://tizen.org/appcontrol/data/total_count"

Definition for app_control data: Total count.

Since :
2.4
#define APP_CONTROL_DATA_TOTAL_SIZE   "http://tizen.org/appcontrol/data/total_size"

Definition for app_control data: Total size (unit : bytes)

Since :
2.4
#define APP_CONTROL_DATA_TYPE   "http://tizen.org/appcontrol/data/type"

Definition for app_control data: Type.

Since :
2.4
#define APP_CONTROL_DATA_URL   "http://tizen.org/appcontrol/data/url"

Definition for app_control data: URLs.

Since :
2.4
#define APP_CONTROL_OPERATION_ADD   "http://tizen.org/appcontrol/operation/add"

Definition for the app_control operation: Adds an item.

Input: It depends on application scenario/configuration.
Output: It depends on application scenario/configuration.

Since :
2.4
#define APP_CONTROL_OPERATION_CALL   "http://tizen.org/appcontrol/operation/call"

Definition for the app_control operation: Performs a call to someone.

Input: URI is the number to be dialed. This is mandatory field.
Output: Nothing

Since :
2.3
Privilege Level:
public
Privilege:
http://tizen.org/privilege/call
Remarks:
When you request this operation, you must declare this privilege.
#define APP_CONTROL_OPERATION_COMPOSE   "http://tizen.org/appcontrol/operation/compose"

Definition for the app_control operation: Composes a message.

Input: It depends on application scenario/configuration.
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_CREATE_CONTENT   "http://tizen.org/appcontrol/operation/create_content"

Definition for the app_control operation: Creates contents.

Input: It depends on application scenario/configuration.
Output: APP_CONTROL_DATA_SELECTED in Extra

Since :
2.3
#define APP_CONTROL_OPERATION_DEFAULT   "http://tizen.org/appcontrol/operation/default"

Definition for the app_control operation: An explicit launch for an application that excludes a homescreen application.

Input: Nothing
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_DIAL   "http://tizen.org/appcontrol/operation/dial"

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.

Input: URI is the number to be dialed. If empty, show a UI without number.
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_DOWNLOAD   "http://tizen.org/appcontrol/operation/download"

Definition for the app_control operation: Downloads items.

Input: It depends on application scenario/configuration.
Output: It depends on application scenario/configuration.

Since :
2.3
Privilege Level:
public
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_EDIT   "http://tizen.org/appcontrol/operation/edit"

Definition for the app_control operation: Provides an editable access to the given data.

Input: It depends on application scenario/configuration.
Output: It depends on application scenario/configuration.

Since :
2.3
#define APP_CONTROL_OPERATION_IMAGE_CAPTURE   "http://tizen.org/appcontrol/operation/image_capture"

Definition for the app_control operation: Captures images by camera applications.

Input: Nothing
Output: APP_CONTROL_DATA_SELECTED in Extra

Since :
2.4
#define APP_CONTROL_OPERATION_LAUNCH_ON_EVENT   "http://tizen.org/appcontrol/operation/launch_on_event"

Definition for the app_control operation: Can be launched by interested System-Event.

Input : URI and extras data defined in Event module.
Output: Nothing

Since :
2.4
Remarks:
This operation is for handling event from the platform. This operation can not be requested via app_control_send_launch_request().
Refer to Launch-On-Event section of Event module.
#define APP_CONTROL_OPERATION_MAIN   "http://tizen.org/appcontrol/operation/main"

Definition for the app_control operation: An explicit launch for a homescreen application.

Input: Nothing
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_MULTI_SHARE   "http://tizen.org/appcontrol/operation/multi_share"

Definition for the app_control operation: Shares multiple items with someone else.

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).
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_PICK   "http://tizen.org/appcontrol/operation/pick"

Definition for the app_control operation: Picks items.

Input: It depends on application scenario/configuration.
Output: APP_CONTROL_DATA_SELECTED in Extra

Since :
2.3
#define APP_CONTROL_OPERATION_PRINT   "http://tizen.org/appcontrol/operation/print"

Definition for the app_control operation: Prints contents.

Input: It depends on application scenario/configuration.
Output: It depends on application scenario/configuration.

Since :
2.3
#define APP_CONTROL_OPERATION_SEARCH   "http://tizen.org/appcontrol/operation/search"

Definition for the app_control operation: Performs a search.

Input: APP_CONTROL_DATA_TEXT in Extra is the text to search for. If empty, show a search UI.
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_SEND   "http://tizen.org/appcontrol/operation/send"

Definition for the app_control operation: Delivers some data to someone else.

Since :
2.3
Deprecated:
Deprecated since 2.4. Use APP_CONTROL_OPERATION_SHARE instead.
#define APP_CONTROL_OPERATION_SEND_TEXT   "http://tizen.org/appcontrol/operation/send_text"

Definition for the app_control operation: Delivers text data to someone else.

Since :
2.3
Deprecated:
Deprecated since 2.4. Use APP_CONTROL_OPERATION_SHARE_TEXT instead.
#define APP_CONTROL_OPERATION_SETTING   "http://tizen.org/appcontrol/operation/setting"

Definition for the app_control operation: Shows system settings.

Input: Nothing
Output: Nothing

Since :
2.4
#define APP_CONTROL_OPERATION_SETTING_BT_ENABLE   "http://tizen.org/appcontrol/operation/setting/bt_enable"

Definition for the app_control operation: Shows settings to enable Bluetooth.

Input: Nothing
Output: Nothing

Since :
2.4
#define APP_CONTROL_OPERATION_SETTING_BT_VISIBILITY   "http://tizen.org/appcontrol/operation/setting/bt_visibility"

Definition for the app_control operation: Shows settings to configure Bluetooth visibility.

Input: Nothing
Output: Nothing

Since :
2.4
#define APP_CONTROL_OPERATION_SETTING_LOCATION   "http://tizen.org/appcontrol/operation/setting/location"

Definition for the app_control operation: Shows settings to allow configuration of current location sources.

Input: Nothing
Output: Nothing

Since :
2.4
#define APP_CONTROL_OPERATION_SETTING_NFC   "http://tizen.org/appcontrol/operation/setting/nfc"

Definition for the app_control operation: Shows NFC settings.

Input: Nothing
Output: Nothing

Since :
2.4
#define APP_CONTROL_OPERATION_SETTING_WIFI   "http://tizen.org/appcontrol/operation/setting/wifi"

Definition for the app_control operation: Shows settings to allow configuration of Wi-Fi.

Input: Nothing
Output: Nothing

Since :
2.4
#define APP_CONTROL_OPERATION_SHARE   "http://tizen.org/appcontrol/operation/share"

Definition for the app_control operation: Shares an item with someone else.

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).
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_SHARE_TEXT   "http://tizen.org/appcontrol/operation/share_text"

Definition for the app_control operation: Shares text data with someone else.

Input: APP_CONTROL_DATA_TEXT in Extra is the text to share
Output: Nothing

Since :
2.3
#define APP_CONTROL_OPERATION_VIDEO_CAPTURE   "http://tizen.org/appcontrol/operation/video_capture"

Definition for the app_control operation: Captures videos by camera applications.

Input: Nothing
Output: APP_CONTROL_DATA_SELECTED in Extra

Since :
2.4
#define APP_CONTROL_OPERATION_VIEW   "http://tizen.org/appcontrol/operation/view"

Definition for the app_control operation: Displays the data.

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).
Output: Nothing

Since :
2.3

Typedef Documentation

typedef bool(* app_control_app_matched_cb)(app_control_h app_control, const char *appid, void *user_data)

Called once for each matched application that can be launched to handle the given app_control request.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]packageThe package name of the application that can handle the launch request of the given app_control
[in]user_dataThe user data passed from the foreach function
Returns:
true to continue with the next iteration of the loop, otherwise false to break out of the loop
Precondition:
app_control_foreach_app_matched() will invoke this callback.
See also:
app_control_foreach_app_matched()
typedef bool(* app_control_extra_data_cb)(app_control_h app_control, const char *key, void *user_data)

Called to retrieve the extra data contained in the app_control.

Since :
2.3
Remarks:
The key must not be deallocated by the application.
Parameters:
[in]app_controlThe app_control handle
[in]keyThe key of the value contained in the app_control
[in]user_dataThe user data passed from the foreach function
Returns:
true to continue with the next iteration of the loop, otherwise false to break out of the loop
Precondition:
app_control_foreach_extra_data() will invoke this callback.
See also:
app_control_foreach_extra_data()
typedef struct app_control_s* app_control_h

App Control handle.

Since :
2.3
typedef void(* app_control_reply_cb)(app_control_h request, app_control_h reply, app_control_result_e result, void *user_data)

Called when the reply of the launch request is delivered.

Since :
2.3
Remarks:
The request and reply must not be deallocated by the application.
Parameters:
[in]requestThe app_control handle of the launch request that has been sent
[in]replyThe app_control handle in which the results of the callee are contained
[in]resultThe result code of the launch request
[in]user_dataThe user data passed from the callback registration function
Precondition:
When the callee replies to the launch request, this callback will be invoked.
Since 2.4, if APP_CONTROL_RESULT_APP_STARTED event is enabled, this callback also will be invoked when the callee app actually launched.
See also:
app_control_send_launch_request()
app_control_reply_to_launch_request()
app_control_enable_app_started_result_event()
APP_CONTROL_RESULT_APP_STARTED

Enumeration Type Documentation

enum app_control_error_e

Enumeration for App Control Error.

Since :
2.3
Enumerator:
APP_CONTROL_ERROR_NONE 

Successful

APP_CONTROL_ERROR_INVALID_PARAMETER 

Invalid parameter

APP_CONTROL_ERROR_OUT_OF_MEMORY 

Out of memory

APP_CONTROL_ERROR_APP_NOT_FOUND 

The application is not found

APP_CONTROL_ERROR_KEY_NOT_FOUND 

Specified key is not found

APP_CONTROL_ERROR_KEY_REJECTED 

Key is not available

APP_CONTROL_ERROR_INVALID_DATA_TYPE 

Invalid data type

APP_CONTROL_ERROR_LAUNCH_REJECTED 

The application cannot be launched now

APP_CONTROL_ERROR_PERMISSION_DENIED 

Permission denied

APP_CONTROL_ERROR_LAUNCH_FAILED 

Internal launch error

APP_CONTROL_ERROR_TIMED_OUT 

Time out

APP_CONTROL_ERROR_IO_ERROR 

IO error

enum app_control_launch_mode_e

Enumeration for App Control Launch Mode.

Since :
2.4
Enumerator:
APP_CONTROL_LAUNCH_MODE_SINGLE 

Prefer to launch an application as single mode

APP_CONTROL_LAUNCH_MODE_GROUP 

Prefer to launch an application as group mode

enum app_control_result_e

Enumeration for App Control Result.

See also:
app_control_enable_app_started_result_event()
Since :
2.3
Enumerator:
APP_CONTROL_RESULT_APP_STARTED 

Callee application launched actually (Since 2.4)

APP_CONTROL_RESULT_SUCCEEDED 

Operation succeeded

APP_CONTROL_RESULT_FAILED 

Operation failed by the callee

APP_CONTROL_RESULT_CANCELED 

Operation canceled by the platform

Function Documentation

int app_control_add_extra_data ( app_control_h  app_control,
const char *  key,
const char *  value 
)

Adds extra data to the app_control.

Since :
2.3
Remarks:
The function replaces any existing value for the given key.
The function returns APP_CONTROL_ERROR_INVALID_PARAMETER if key or value is a zero-length string.
The function returns APP_CONTROL_ERROR_KEY_REJECTED if the application tries to use the same key with system-defined key.
Parameters:
[in]app_controlThe app_control handle
[in]keyThe name of the extra data
[in]valueThe value associated with the given key
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_KEY_REJECTEDKey not available
See also:
app_control_add_extra_data_array()
app_control_remove_extra_data()
app_control_get_extra_data()
int app_control_add_extra_data_array ( app_control_h  app_control,
const char *  key,
const char *  value[],
int  length 
)

Adds the extra data array to the app_control.

Since :
2.3
Remarks:
The function replaces any existing value for the given key.
The function returns APP_CONTROL_ERROR_INVALID_PARAMETER if key is a zero-length string.
The function returns APP_CONTROL_ERROR_KEY_REJECTED if the application tries to use the same key with system-defined key.
Parameters:
[in]app_controlThe app_control handle
[in]keyThe name of the extra data
[in]valueThe array value associated with the given key
[in]lengthThe length of the array
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_KEY_REJECTEDKey not available
See also:
app_control_add_extra_data()
app_control_remove_extra_data()
app_control_get_extra_data()
int app_control_clone ( app_control_h *  clone,
app_control_h  app_control 
)

Creates and returns a copy of the given app_control handle.

Since :
2.3
Remarks:
A newly created app_control should be destroyed by calling app_control_destroy() if it is no longer needed.
Parameters:
[out]cloneIf successful, a newly created app_control handle will be returned
[in]app_controlThe app_control handle
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_destroy()
int app_control_create ( app_control_h *  app_control)

Creates an app_control handle.

Since :
2.3
Remarks:
The app_control must be released using app_control_destroy().
Parameters:
[out]app_controlThe app_control handle to be newly created on success
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_destroy()
int app_control_destroy ( app_control_h  app_control)

Destroys the app_control handle and releases all its resources.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_create()
int app_control_enable_app_started_result_event ( app_control_h  app_control)

Enables additional launch result event on launch request.

The function allows to receive APP_CONTROL_RESULT_APP_STARTED event on
application get launched by app_control.

Remarks:
app_control_reply_cb() will be called on APP_CONTROL_RESULT_APP_STARTED event received.
Since :
2.4
Parameters:
[in]app_controlThe app_control handle
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_send_launch_request()
APP_CONTROL_RESULT_APP_STARTED
int app_control_foreach_app_matched ( app_control_h  app_control,
app_control_app_matched_cb  callback,
void *  user_data 
)

Retrieves all applications that can be launched to handle the given app_control request.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]callbackThe iteration callback function
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccess
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
Postcondition:
This function invokes app_control_app_matched_cb().
See also:
app_control_app_matched_cb()
int app_control_foreach_extra_data ( app_control_h  app_control,
app_control_extra_data_cb  callback,
void *  user_data 
)

Retrieves all extra data contained in app_control.

This function calls app_control_extra_data_cb() once for each key-value pair for extra data contained in app_control.
If the app_control_extra_data_cb() callback function returns false, then iteration will be finished.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]callbackThe iteration callback function
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
Postcondition:
This function invokes app_control_extra_data_cb().
See also:
app_control_extra_data_cb()
int app_control_get_app_id ( app_control_h  app_control,
char **  app_id 
)

Gets the ID of the application to explicitly launch.

Since :
2.3
Remarks:
The app_id must be released with free().
Parameters:
[in]app_controlThe app_control handle
[out]app_idThe ID of the application to explicitly launch
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_set_app_id()
int app_control_get_caller ( app_control_h  app_control,
char **  id 
)

Gets the application ID of the caller from the launch request.

Since :
2.3
Remarks:
The app_control must be the launch request from app_control_cb().
This function returns APP_CONTROL_ERROR_INVALID_PARAMETER if the given app_control is not the launch request.
The id must be released using free().
Parameters:
[in]app_controlThe app_control handle from app_control_cb()
[out]idThe application ID of the caller
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
int app_control_get_category ( app_control_h  app_control,
char **  category 
)

Gets the explicit category.

Since :
2.3
Remarks:
The category must be released using free().
Parameters:
[in]app_controlThe app_control handle
[out]categoryThe explicit category
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_set_category()
int app_control_get_extra_data ( app_control_h  app_control,
const char *  key,
char **  value 
)

Gets the extra data from the app_control.

Since :
2.3
Remarks:
The value must be released using free().
The function returns APP_CONTROL_ERROR_INVALID_DATA_TYPE if value is of array data type.
Parameters:
[in]app_controlThe app_control handle
[in]keyThe name of the extra data
[out]valueThe value associated with the given key
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_KEY_NOT_FOUNDSpecified key not found
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
APP_CONTROL_ERROR_INVALID_DATA_TYPEInvalid data type
APP_CONTROL_ERROR_KEY_REJECTEDKey not available
See also:
app_control_add_extra_data()
app_control_add_extra_data_array()
app_control_get_extra_data()
app_control_remove_extra_data()
app_control_foreach_extra_data()
int app_control_get_extra_data_array ( app_control_h  app_control,
const char *  key,
char ***  value,
int *  length 
)

Gets the extra data array from the app_control.

Since :
2.3
Remarks:
The value must be released using free().
The function returns APP_CONTROL_ERROR_INVALID_DATA_TYPE if value is not of array data type.
Parameters:
[in]app_controlThe app_control handle
[in]keyThe name of the extra data
[out]valueThe array value associated with the given key
[out]lengthThe length of the array
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_KEY_NOT_FOUNDSpecified key not found
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
APP_CONTROL_ERROR_INVALID_DATA_TYPEInvalid data type
APP_CONTROL_ERROR_KEY_REJECTEDKey not available
See also:
app_control_add_extra_data()
app_control_add_extra_data_array()
app_control_remove_extra_data()
app_control_foreach_extra_data()
int app_control_get_launch_mode ( app_control_h  app_control,
app_control_launch_mode_e *  mode 
)

Gets the launch mode of the application.

Since :
2.4
Parameters:
[in]app_controlThe app_control handle
[out]launch_modeThe launch mode of app
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_get_launch_mode()
app_control_launch_mode_e
int app_control_get_mime ( app_control_h  app_control,
char **  mime 
)

Gets the explicit MIME type of the data.

Since :
2.3
Remarks:
The uri must be released using free().
Parameters:
[in]app_controlThe app_control handle
[out]mimeThe explicit MIME type of the data this app_control is operating on
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_set_mime()
int app_control_get_operation ( app_control_h  app_control,
char **  operation 
)

Gets the operation to be performed.

Since :
2.3
Remarks:
The operation must be released using free().
Parameters:
[in]app_controlThe app_control handle
[out]operationThe operation to be performed
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_set_operation()
int app_control_get_uri ( app_control_h  app_control,
char **  uri 
)

Gets the URI of the data.

Since :
2.3
Remarks:
The uri must be released using free().
Parameters:
[in]app_controlThe app_control handle
[out]uriThe URI of the data this app_control is operating on
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_set_uri()
int app_control_is_extra_data_array ( app_control_h  app_control,
const char *  key,
bool *  array 
)

Checks whether the extra data associated with the given key is of array data type.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]keyThe name of the extra data
[out]arrayIf true the extra data is of array data type, otherwise false
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_add_extra_data()
app_control_add_extra_data_array()
app_control_remove_extra_data()
app_control_foreach_extra_data()
int app_control_is_reply_requested ( app_control_h  app_control,
bool *  requested 
)

Checks whether the caller is requesting a reply from the launch request.

Since :
2.3
Remarks:
The app_control must be the launch request from app_control_cb().
This function returns APP_CONTROL_ERROR_INVALID_PARAMETER if the given app_control is not the launch request.
Parameters:
[in]app_controlThe app_control handle from app_control_cb()
[out]requestedIf true a reply is requested by the caller, otherwise false
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
int app_control_remove_extra_data ( app_control_h  app_control,
const char *  key 
)

Removes the extra data from the app_control.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]keyThe name of the extra data
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_KEY_NOT_FOUNDSpecified key not found
APP_CONTROL_ERROR_KEY_REJECTEDKey not available
See also:
app_control_add_extra_data()
app_control_add_extra_data_array()
app_control_get_extra_data()
int app_control_reply_to_launch_request ( app_control_h  reply,
app_control_h  request,
app_control_result_e  result 
)

Replies to the launch request sent by the caller.

If the caller application sent the launch request to receive the result, the callee application can return the result back to the caller.

Since :
2.3
Remarks:
The function is not allowed to send reply APP_CONTROL_RESULT_APP_STARTED as result which is reserved for platform developers.
Parameters:
[in]replyThe app_control handle in which the results of the callee are contained
[in]requestThe app_control handle sent by the caller
[in]resultThe result code of the launch request
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_send_launch_request()
int app_control_send_launch_request ( app_control_h  app_control,
app_control_reply_cb  callback,
void *  user_data 
)

Sends the launch request.

The operation is mandatory information for the launch request.
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 :
2.3
Privilege Level:
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 Event module.
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 app_control_set_app_id() MUST be sent.
Parameters:
[in]app_controlThe app_control handle
[in]callbackThe callback function to be called when the reply is delivered
[in]user_dataThe user data to be passed to the callback function
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
APP_CONTROL_ERROR_APP_NOT_FOUNDThe application to run the given launch request is not found
APP_CONTROL_ERROR_LAUNCH_REJECTEDThe application cannot be launched in current context
APP_CONTROL_ERROR_LAUNCH_FAILEDFailed to launch the application
APP_CONTROL_ERROR_TIMED_OUTFailed due to timeout. The application that handles app_control may be busy
APP_CONTROL_ERROR_PERMISSION_DENIEDPermission denied
Postcondition:
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.
See also:
app_control_reply_to_launch_request()
app_control_reply_cb()
app_control_enable_app_started_result_event()
int app_control_send_terminate_request ( app_control_h  app_control)

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 2.4, 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 :
2.3
Parameters:
[in]app_controlThe app_control handle
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_PERMISSION_DENIEDPermission denied
See also:
app_control_send_launch_request()
app_control_set_launch_mode()
int app_control_set_app_id ( app_control_h  app_control,
const char *  app_id 
)

Sets the ID of the application to explicitly launch.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]app_idThe ID of the application to explicitly launch (if the app_id is NULL, it clears the previous value)
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
APP_CONTROL_ERROR_OUT_OF_MEMORYOut of memory
See also:
app_control_get_app_id()
int app_control_set_category ( app_control_h  app_control,
const char *  category 
)

Sets the explicit category.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]categoryThe explicit category (if the category is NULL, it clears the previous value)
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_get_category()
int app_control_set_launch_mode ( app_control_h  app_control,
app_control_launch_mode_e  mode 
)

Sets the launch mode of the application.

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.
Sub-applications which were launched as group mode always have own process.
Since :
2.4
Parameters:
[in]app_controlThe app_control handle
[in]launch_modeThe launch mode of app
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_set_launch_mode()
app_control_launch_mode_e
int app_control_set_mime ( app_control_h  app_control,
const char *  mime 
)

Sets the explicit MIME type of the data.

Since :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]mimeThe explicit MIME type of the data this app_control is operating on (if the mime is NULL, it clears the previous value)
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_get_mime()
int app_control_set_operation ( app_control_h  app_control,
const char *  operation 
)

Sets the operation to be performed.

The 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 :
2.3
Parameters:
[in]app_controlThe app_control handle
[in]operationThe operation to be performed (if the operation is NULL, it clears the previous value)
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_get_operation()
APP_CONTROL_OPERATION_DEFAULT
APP_CONTROL_OPERATION_EDIT
APP_CONTROL_OPERATION_VIEW
APP_CONTROL_OPERATION_PICK
APP_CONTROL_OPERATION_CREATE_CONTENT
APP_CONTROL_OPERATION_CALL
APP_CONTROL_OPERATION_SEND
APP_CONTROL_OPERATION_SEND_TEXT
APP_CONTROL_OPERATION_DIAL
APP_CONTROL_OPERATION_SEARCH
int app_control_set_uri ( app_control_h  app_control,
const char *  uri 
)

Sets the URI of the data.

Since :
2.3
Remarks:
Since Tizen 2.4, 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.
Parameters:
[in]app_controlThe app_control handle
[in]uriThe URI of the data this app_control is operating on (if the uri is NULL, it clears the previous value)
Returns:
0 on success, otherwise a negative error value
Return values:
APP_CONTROL_ERROR_NONESuccessful
APP_CONTROL_ERROR_INVALID_PARAMETERInvalid parameter
See also:
app_control_get_uri()