Tizen Native API

The App Control API provides functions to launch other applications.

Required Header

#include <app_control.h>

Overview

Platform Application Controls

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.

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: main operation for an explicit launch.
#define APP_CONTROL_OPERATION_DEFAULT   "http://tizen.org/appcontrol/operation/default"
 Definition for the app_control operation: default operation for an explicit launch.
#define APP_CONTROL_OPERATION_EDIT   "http://tizen.org/appcontrol/operation/edit"
 Definition for the app_control operation: provides an explicit 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 an item from the data, returning what is selected.
#define APP_CONTROL_OPERATION_CREATE_CONTENT   "http://tizen.org/appcontrol/operation/create_content"
 Definition for the app_control operation: creates content, returning what is created.
#define APP_CONTROL_OPERATION_CALL   "http://tizen.org/appcontrol/operation/call"
 Definition for the app_control operation: performs a call to someone specified by the data.
#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 as specified by the data.
#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 an item.
#define APP_CONTROL_OPERATION_PRINT   "http://tizen.org/appcontrol/operation/print"
 Definition for the app_control operation: prints content.
#define APP_CONTROL_OPERATION_COMPOSE   "http://tizen.org/appcontrol/operation/compose"
 Definition for the app_control operation: composes.
#define APP_CONTROL_OPERATION_GET_INPUT   "http://tizen.org/appcontrol/operation/get_input"
 Definition for the app_control operation: Select the type of input method to receive input from user.
#define APP_CONTROL_DATA_SUBJECT   "http://tizen.org/appcontrol/data/subject"
 Definition for app_control optional data: the subject of a message.
#define APP_CONTROL_DATA_TO   "http://tizen.org/appcontrol/data/to"
 Definition for app_control optional data: e-mail addresses.
#define APP_CONTROL_DATA_CC   "http://tizen.org/appcontrol/data/cc"
 Definition for app_control optional data: e-mail addresses that should be carbon copied.
#define APP_CONTROL_DATA_BCC   "http://tizen.org/appcontrol/data/bcc"
 Definition for app_control optional 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 optional data: the content of the data is associated with APP_CONTROL_OPERATION_SEND.
#define APP_CONTROL_DATA_TITLE   "http://tizen.org/appcontrol/data/title"
 Definition for app_control optional data: the title of the data.
#define APP_CONTROL_DATA_SELECTED   "http://tizen.org/appcontrol/data/selected"
 Definition for app_control optional data: the path of a selected item.
#define APP_CONTROL_DATA_PATH   "http://tizen.org/appcontrol/data/path"
 Definition for app_control optional data: multiple item path to deliver.
#define APP_CONTROL_DATA_SELECTION_MODE   "http://tizen.org/appcontrol/data/selection_mode"
 Definition for app_control optional data: the selection type.
#define APP_CONTROL_DATA_INPUT_TYPE   "http://tizen.org/appcontrol/data/input_type"
 Definition for app_control data: Select the type of input method.
#define APP_CONTROL_DATA_INPUT_DEFAULT_TEXT   "http://tizen.org/appcontrol/data/input_default_text"
 Definition for app_control data: Send the pre inputted text such as "http://" in web.
#define APP_CONTROL_DATA_INPUT_GUIDE_TEXT   "http://tizen.org/appcontrol/data/input_guide_text"
 Definition for app_control data: Send guide text to show to user such as "Input user name".
#define APP_CONTROL_DATA_INPUT_PREDICTION_HINT   "http://tizen.org/appcontrol/data/input_prediction_hint"
 Definition for app_control data: Send text to receive answer result from smart reply.
#define APP_CONTROL_DATA_TYPE   "http://tizen.org/appcontrol/data/type"
 Definition for app_control data: Type.

Define Documentation

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

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

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

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

Since :
2.3.1
#define APP_CONTROL_DATA_INPUT_DEFAULT_TEXT   "http://tizen.org/appcontrol/data/input_default_text"

Definition for app_control data: Send the pre inputted text such as "http://" in web.

Since :
2.3.2
#define APP_CONTROL_DATA_INPUT_GUIDE_TEXT   "http://tizen.org/appcontrol/data/input_guide_text"

Definition for app_control data: Send guide text to show to user such as "Input user name".

Since :
2.3.2
#define APP_CONTROL_DATA_INPUT_PREDICTION_HINT   "http://tizen.org/appcontrol/data/input_prediction_hint"

Definition for app_control data: Send text to receive answer result from smart reply.

Since :
2.3.2
#define APP_CONTROL_DATA_INPUT_TYPE   "http://tizen.org/appcontrol/data/input_type"

Definition for app_control data: Select the type of input method.

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.

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

Definition for app_control optional data: multiple item path to deliver.

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

Definition for app_control optional data: the path of a selected item.

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

Definition for app_control optional data: the selection type.

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

Definition for app_control optional data: the subject of a message.

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

Definition for app_control optional data: the content of the data is associated with APP_CONTROL_OPERATION_SEND.

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

Definition for app_control optional data: the title of the data.

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

Definition for app_control optional data: e-mail addresses.

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

Definition for app_control data: Type.

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

Definition for the app_control operation: performs a call to someone specified by the data.

Since :
2.3.1
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.

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

Definition for the app_control operation: creates content, returning what is created.

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

Definition for the app_control operation: default operation for an explicit launch.

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

Definition for the app_control operation: dials a number as specified by the data.

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

Definition for the app_control operation: downloads an item.

Since :
2.3.1
#define APP_CONTROL_OPERATION_EDIT   "http://tizen.org/appcontrol/operation/edit"

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

Since :
2.3.1
#define APP_CONTROL_OPERATION_GET_INPUT   "http://tizen.org/appcontrol/operation/get_input"

Definition for the app_control operation: Select the type of input method to receive input from user.

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

Since :
2.3.2
#define APP_CONTROL_OPERATION_MAIN   "http://tizen.org/appcontrol/operation/main"

Definition for the app_control operation: main operation for an explicit launch.

Since :
2.3.1
#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.

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

Definition for the app_control operation: picks an item from the data, returning what is selected.

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

Definition for the app_control operation: prints content.

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

Definition for the app_control operation: performs a search.

Since :
2.3.1
#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.1
#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.1
#define APP_CONTROL_OPERATION_SHARE   "http://tizen.org/appcontrol/operation/share"

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

Since :
2.3.1
#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.

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

Definition for the app_control operation: displays the data.

Since :
2.3.1

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.1
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.1
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.1
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.1
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.
See also:
app_control_send_launch_request()
app_control_reply_to_launch_request()

Enumeration Type Documentation

Enumeration for App Control Error.

Since :
2.3.1
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

Enumeration for App Control Result.

Since :
2.3.1
Enumerator:
APP_CONTROL_RESULT_SUCCEEDED 

Operation succeeded

APP_CONTROL_RESULT_FAILED 

Operation failed by the callee

APP_CONTROL_RESULT_CANCELED 

Operation canceled by the framework


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.1
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.1
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.1
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.1
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.1
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_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.1
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.1
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.1
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.1
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.1
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.1
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
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.1
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
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_mime ( app_control_h  app_control,
char **  mime 
)

Gets the explicit MIME type of the data.

Since :
2.3.1
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.1
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.1
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.1
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.1
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.1
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
See also:
app_control_add_extra_data()
app_control_add_extra_data_array()
app_control_get_extra_data()

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.1
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.

Remarks:
In some implementations of the Tizen platform, service applications are only allowed to be launched explicitly by the application in the same package; hence you should not use this function to launch the service application that is not in the your application package.
Since :
2.3.1
Privilege Level:
public
Privilege:
http://tizen.org/privilege/appmanager.launch
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.
See also:
app_control_reply_to_launch_request()
app_control_reply_cb()

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.

Since :
2.3.1
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()
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.1
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.1
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_mime ( app_control_h  app_control,
const char *  mime 
)

Sets the explicit MIME type of the data.

Since :
2.3.1
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.1
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.1
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()