The ApplicationManager interface also provides methods to launch other applications explicitly and implicitly through the ApplicationControl interface. The ApplicationControl interface consists of an operation, URI, and MIME type and also describes an action to be performed by other applications and can carry the result from the subsequent application. The ApplicationManager interface also provides methods to handle the application lifecycle, to access the installed applications on the device, and to let an application be notified of a change in the application list.
The Application interface defines the current application's information and the basic operations for the current application such as exit or hide.
For more information on the Application features, see Application Guide.
Since: 1.0
[NoInterfaceObject] interface ApplicationManagerObject { readonly attribute ApplicationManager application; };
Tizen implements ApplicationManagerObject;
Since: 2.0
The tizen.application object allows access to the Application API's functionality.
[NoInterfaceObject] interface ApplicationManager { Application getCurrentApplication() raises(WebAPIException); void kill(ApplicationContextId contextId, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void launch(ApplicationId id, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void launchAppControl(ApplicationControl appControl, optional ApplicationId? id, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback, optional ApplicationControlDataArrayReplyCallback? replyCallback) raises(WebAPIException); void findAppControl(ApplicationControl appControl, FindAppControlSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void getAppsContext(ApplicationContextArraySuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); ApplicationContext getAppContext(optional ApplicationContextId? contextId) raises(WebAPIException); void getAppsInfo(ApplicationInformationArraySuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); ApplicationInformation getAppInfo(optional ApplicationId? id) raises(WebAPIException); ApplicationCertificate[] getAppCerts(optional ApplicationId? id) raises(WebAPIException); DOMString getAppSharedURI(optional ApplicationId? id) raises(WebAPIException); ApplicationMetaData[] getAppMetaData(optional ApplicationId? id) raises(WebAPIException); long addAppInfoEventListener(ApplicationInformationEventCallback eventCallback) raises(WebAPIException); void removeAppInfoEventListener(long watchId) raises(WebAPIException); };
Since: 2.0
getCurrentApplication
Application getCurrentApplication();
Since: 2.0
Return value:
Application The data structure that defines the current application.Exceptions:
with error type UnknownError, if the application cannot be retrieved because of an unknown error.
Code example:
var app = tizen.application.getCurrentApplication(); console.log("Current application's app id is " + app.appInfo.id);
kill
void kill(ApplicationContextId contextId, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback);
Since: 2.0
The ErrorCallback method is launched with these error types:
Privilege level: partner
Privilege: http://tizen.org/privilege/appmanager.kill
Parameters:
Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
with error type SecurityError, if the application does not have the privilege to call this method.
Code example:
function onKillSuccess() { console.log("Application terminated successfully"); } function onRunningAppsContext(contexts) { // let's assume that the application "targetApp0.main" has been installed. var targetId = "targetApp0.main"; for (var i = 0; i < contexts.length; i++) { if (contexts[i].appId == targetId) { tizen.application.kill(contexts[i].id, onKillSuccess); } } } tizen.application.getAppsContext(onRunningAppsContext);
launch
void launch(ApplicationId id, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback);
Since: 2.0
The ErrorCallback method is launched with these error types:
Privilege level: public
Privilege: http://tizen.org/privilege/application.launch
Parameters:
Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
with error type SecurityError, if the application does not have the privilege to call this method.
Code example:
function onsuccess() { console.log("The application has launched successfully"); } // let's assume that application "targetApp0.main" has been installed tizen.application.launch("targetApp0.main", onsuccess);
launchAppControl
void launchAppControl(ApplicationControl appControl, optional ApplicationId? id, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback, optional ApplicationControlDataArrayReplyCallback? replyCallback);
Since: 2.0
An application can launch other applications with the application control, and get back the results from the launched applications.
The application control consists of an operation, URI, and MIME type, and describes the request to be performed by the newly launched application. The application control is passed to the launchAppControl() method to launch an application. The system tries to find the proper application to perform the requested application control, then launches the selected application.
The application control request is passed to the newly launched application and it can be accessed by the getRequestedAppControl() method. The passed application control contains the reason the application has been launched and information about what the application is doing. The launched application can send a result to the caller application with the replyResult() method of the RequestedApplicationControl interface.
The ErrorCallback method is launched with these error types:
Privilege level: public
Privilege: http://tizen.org/privilege/application.launch
Parameters:
Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
with error type SecurityError, if the application does not have the privilege to call this method.
Code example:
var appControl = new tizen.ApplicationControl( "http://tizen.org/appcontrol/operation/pick", null, "image/jpeg", null); var appControlReplyCallback = { // callee sent a reply onsuccess: function(data) { for (var i = 0; i < data.length; i++) { if (data[i].key == "http://tizen.org/appcontrol/data/selected") { console.log('Selected image is ' + data[i].value[0]); } } }, // callee returned failure onfailure: function() { console.log('The launch application control failed'); } } tizen.application.launchAppControl( appControl, null, function() {console.log("launch application control succeed"); }, function(e) {console.log("launch application control failed. reason: " + e.message); }, appControlReplyCallback );
findAppControl
void findAppControl(ApplicationControl appControl, FindAppControlSuccessCallback successCallback, optional ErrorCallback? errorCallback);
Since: 2.0
An application can get a list of other applications that can be launched with the application control.
The ErrorCallback method is launched with these error types:
Parameters:
Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
Code example:
var appControl = new tizen.ApplicationControl( "http://tizen.org/appcontrol/operation/pick", null, "image/jpeg", null); function successCB(appInfos, appControl) { // appControl is same object with the value passed as first parameter to findAppControl() var appControlReplyCallback = { // callee sent a reply onsuccess: function(data) { for (var i = 0; i < data.length; i++) { if (data[i].key == "http://tizen.org/appcontrol/data/selected") { console.log('Selected image is ' + data[i].value[0]); } } }, // callee returned failure onfailure: function() { console.log('The launch application control failed'); } } var appId = appInfos[0].id; // select first app's id tizen.application.launchAppControl( appControl, appId, function() {console.log("launch application control succeed"); }, function(e) {console.log("launch application control failed. reason: " + e.message); }, appControlReplyCallback ); } tizen.application.findAppControl(appControl, successCB);
getAppsContext
void getAppsContext(ApplicationContextArraySuccessCallback successCallback, optional ErrorCallback? errorCallback);
Since: 2.0
The ErrorCallback method is launched with this error type:
Parameters:
Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
Code example:
function onRunningAppsContext(contexts) { for (var i = 0; i < contexts.length; i++) console.log("ID : " + contexts[i].id); } tizen.application.getAppsContext(onRunningAppsContext);
getAppContext
ApplicationContext getAppContext(optional ApplicationContextId? contextId);
Since: 2.0
Parameters:
Return value:
ApplicationContext A data structure that lists running application details.Exceptions:
with error type NotFoundError, if the application context is not found with the specified ID.
with error type UnknownError, if the application context cannot be retrieved because of an unknown error.
Code example:
var appContext = tizen.application.getAppContext(null); console.log("Application context retrieved for app " + appContext.appId);
getAppsInfo
void getAppsInfo(ApplicationInformationArraySuccessCallback successCallback, optional ErrorCallback? errorCallback);
Since: 2.0
The ErrorCallback method is launched with this error type:
Parameters:
Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
Code example:
function onListInstalledApps(applications) { for (var i = 0; i < applications.length; i++) console.log("ID : " + applications[i].id); } tizen.application.getAppsInfo(onListInstalledApps);
getAppInfo
ApplicationInformation getAppInfo(optional ApplicationId? id);
Since: 2.0
If the ID is set to null or not set at all, it returns application information for the current application. The list of installed applications and their application IDs is obtained with getAppsInfo().
Parameters:
Return value:
ApplicationInformation The information of an application.Exceptions:
with error type NotFoundError, if the application is not found with the specified ID.
with error type UnknownError, if the application cannot be retrieved because of an unknown error.
Code example:
var appInfo = tizen.application.getAppInfo(null); console.log("Current application name : " + appInfo.name);
getAppCerts
ApplicationCertificate[] getAppCerts(optional ApplicationId? id);
Since: 2.0
If the ID is set to null or not set at all, it returns application certificates for the current application.
The certificate types are listed below:
Privilege level: partner
Privilege: http://tizen.org/privilege/appmanager.certificate
Parameters:
Return value:
ApplicationCertificate[] Array of certificate information of a specified applicationExceptions:
with error type SecurityError, if the application does not have the privilege to call this method.
with error type NotFoundError, if the application is not found with the specified ID.
with error type UnknownError, if the application cannot be retrieved because of an unknown error.
Code example:
var appCerts = tizen.application.getAppCerts(null); for (var i = 0; i < appCerts.length; i++) { console.log("#" + i + " type:" + appCerts[i].type); console.log("#" + i + " value:" + appCerts[i].value); }
DOMString getAppSharedURI(optional ApplicationId? id);
Since: 2.1
The shared directory is used to export data to other applications. If the ID is set to null or not set at all, it returns the shared directory URI for the current application.
Parameters:
Return value:
DOMString The shared directory URI of an applicationExceptions:
with error type NotFoundError, if the application is not found with the specified ID.
with error type UnknownError, if the application cannot be retrieved because of an unknown error.
Code example:
var sharedDir = tizen.application.getAppSharedURI(null); console.log("shared directory : " + sharedDir);
getAppMetaData
ApplicationMetaData[] getAppMetaData(optional ApplicationId? id);
Since: 2.2
If the ID is set to null or not set at all, it returns the application meta data array for the current application.
Privilege level: public
Privilege: http://tizen.org/privilege/application.info
Parameters:
Return value:
ApplicationMetaData[] Array of meta data of a specified application. If there are no meta data for a specified application, an empty array is returnedExceptions:
with error type SecurityError, if the application does not have the privilege to call this method.
with error type NotFoundError, if the application is not found with the specified ID.
with error type UnknownError, if the application cannot be retrieved because of an unknown error.
Code example:
var metaDataArray = tizen.application.getAppMetaData(null); console.log("size of metadata : " + metaDataArray.length);
addAppInfoEventListener
long addAppInfoEventListener(ApplicationInformationEventCallback eventCallback);
Since: 2.0
It installs a callback that is triggered every time a change occurs on the list of installed applications on a device. This change may occur due to a new installation, uninstallation, or update of an application.
When executed, the implementation must immediately return a listener ID that identifies the listener. After returning the ID, the change detection operation is started asynchronously.
The ApplicationInformationEventCallback must be invoked every time a new application is installed, removed, or updated.
The change detection must continue until the removeAppInfoEventListener() method is called with the corresponding listener identifier.
Parameters:
Return value:
long ID of the listener that can be used to remove the listener later.Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
with error type UnknownError, if it fails to add a listener because of an unknown error.
Code example:
var appEventCallback = { oninstalled: function(appInfo) { console.log('The application ' + appInfo.name + ' is installed'); }, onupdated: function(appInfo) { console.log('The application ' + appInfo.name + ' is updated'); }, onuninstalled: function(appid) { console.log('The application ' + appid + ' is uninstalled'); } }; var watchId = tizen.application.addAppInfoEventListener(appEventCallback);
removeAppInfoEventListener
void removeAppInfoEventListener(long watchId);
Since: 2.0
Parameters:
Exceptions:
with error type InvalidValuesError, if any of the input parameters contain an invalid value.
with error type NotFoundError, if the listener is not found with the specified ID.
with error type UnknownError, if it fails to remove a listener because of an unknown error.
Code example:
tizen.application.removeAppInfoEventListener(watchId);
[NoInterfaceObject] interface Application { readonly attribute ApplicationInformation appInfo; readonly attribute ApplicationContextId contextId; void exit() raises(WebAPIException); void hide() raises(WebAPIException); RequestedApplicationControl getRequestedAppControl() raises(WebAPIException); };
Since: 2.0
Since: 2.0
Since: 2.0
exit
void exit();
Since: 2.0
Exceptions:
with error type UnknownError, if any other error occurs.
Code example:
var app = tizen.application.getCurrentApplication(); app.exit();
hide
void hide();
Since: 2.0
Exceptions:
with error type UnknownError, if any other error occurs.
Code example:
var app = tizen.application.getCurrentApplication(); app.hide();
getRequestedAppControl
RequestedApplicationControl getRequestedAppControl();
Since: 2.0
Gets the requested application control that contains the application control passed by the launchAppControl() method from the calling application. The requested application control contains the reason the application is launched and what it has to perform. For example, an application might be launched to display an image on a page by another application's request. In all of these cases, the application is responsible for checking the contents of the application control and responding appropriately when it is launched.
Return value:
RequestedApplicationControl The details of a requested application controlExceptions:
with error type UnknownError, if the application control cannot be retrieved because of an unknown error.
Code example:
var reqAppControl = tizen.application.getCurrentApplication().getRequestedAppControl(); if (reqAppControl) { console.log("Requester AppID : " + reqAppControl.callerAppId); }
[NoInterfaceObject] interface ApplicationInformation { readonly attribute ApplicationId id; readonly attribute DOMString name; readonly attribute DOMString iconPath; readonly attribute DOMString version; readonly attribute boolean show; readonly attribute DOMString[] categories; readonly attribute Date installDate; readonly attribute long size raises(WebAPIException); readonly attribute PackageId packageId; };
Since: 1.0
Since: 1.0
Since: 1.0
Since: 1.0
Since: 1.0
Since: 1.0
Since: 2.0
Since: 2.0
Since: 2.0
Privilege level: public
Privilege: http://tizen.org/privilege/application.info
Exceptions:
with error type SecurityError, if this attribute is not allowed.
Since: 2.1
[NoInterfaceObject] interface ApplicationContext { readonly attribute ApplicationContextId id; readonly attribute ApplicationId appId; };
Since: 1.0
Since: 1.0
Since: 1.0
[Constructor(DOMString key, DOMString[] value)] interface ApplicationControlData { attribute DOMString key; attribute DOMString[] value; };
Since: 2.0
Code example:
var appControlData = new tizen.ApplicationControlData("image", [imagedata1]);
ApplicationControlData(DOMString key, DOMString[] value);
Since: 2.0
Since: 2.0
[Constructor(DOMString operation, optional DOMString? uri, optional DOMString? mime, optional DOMString? category, optional ApplicationControlData[]? data)] interface ApplicationControl { attribute DOMString operation; attribute DOMString? uri; attribute DOMString? mime; attribute DOMString? category; attribute ApplicationControlData[] data; };
Since: 2.0
Code example:
var appControl = new tizen.ApplicationControl( "http://tizen.org/appcontrol/operation/view", null, "image/jpeg", null, [new tizen.ApplicationControlData("images", [imagedata1, imagedata2])] );
ApplicationControl(DOMString operation, optional DOMString? uri, optional DOMString? mime, optional DOMString? category, optional ApplicationControlData[]? data);
Since: 2.0
Since: 2.0
Since: 2.0
Since: 2.0
Since: 2.0
[NoInterfaceObject] interface RequestedApplicationControl { readonly attribute ApplicationControl appControl; readonly attribute ApplicationId callerAppId; void replyResult(optional ApplicationControlData[]? data) raises(WebAPIException); void replyFailure() raises(WebAPIException); };
Since: 2.0
Code example:
var reqAppControl = tizen.application.getCurrentApplication().getRequestedAppControl(); if (reqAppControl) { console.log("Requester AppID : " + reqAppControl.callerAppId); var appControl = reqAppControl.appControl; if (appControl.operation == "http://tizen.org/appcontrol/operation/pick") { var data = new tizen.ApplicationControlData("http://tizen.org/appcontrol/data/selected", ["Image1.jpg"]); reqAppControl.replyResult([data]); } }
Since: 2.0
Since: 2.1
replyResult
void replyResult(optional ApplicationControlData[]? data);
Since: 2.0
Parameters:
Exceptions:
with error type TypeMismatchError, if any input parameter is not compatible with the expected type for that parameter.
with error type NotFoundError, if the caller app is not alive or there is no response from the caller app.
with error type UnknownError, if the reply request fails because of an unknown error.
replyFailure
void replyFailure();
Since: 2.0
Exceptions:
with error type NotFoundError, if the caller app is not alive or there is no response from the caller app.
with error type UnknownError, if the reply request fails because of an unknown error.
[NoInterfaceObject] interface ApplicationCertificate { readonly attribute DOMString type; readonly attribute DOMString value; };
Since: 2.0
Since: 2.0
Since: 2.0
[NoInterfaceObject] interface ApplicationMetaData { readonly attribute DOMString key; readonly attribute DOMString value; };
Since: 2.2
Since: 2.2
Since: 2.2
[Callback=FunctionOnly, NoInterfaceObject] interface ApplicationInformationArraySuccessCallback { void onsuccess(ApplicationInformation[] informationArray); };
Since: 1.0
This callback interface specifies a success method with an array of ApplicationInformation objects as an input parameter. It is used in ApplicationManager.getAppsInfo().
onsuccess
void onsuccess(ApplicationInformation[] informationArray);
Since: 1.0
Parameters:
[Callback=FunctionOnly, NoInterfaceObject] interface FindAppControlSuccessCallback { void onsuccess(ApplicationInformation[] informationArray, ApplicationControl appControl); };
Since: 2.0
This callback interface specifies a success method with an array of ApplicationInformation objects and application control as an input parameter. It is used in ApplicationManager.findAppControl().
onsuccess
void onsuccess(ApplicationInformation[] informationArray, ApplicationControl appControl);
Since: 2.0
Parameters:
[Callback=FunctionOnly, NoInterfaceObject] interface ApplicationContextArraySuccessCallback { void onsuccess(ApplicationContext[] contexts); };
Since: 1.0
This callback interface specifies a success method with an array of ApplicationContext objects as an input parameter. It is used in ApplicationManager.getAppsContext().
onsuccess
void onsuccess(ApplicationContext[] contexts);
Since: 1.0
Parameters:
[Callback, NoInterfaceObject] interface ApplicationControlDataArrayReplyCallback { void onsuccess(optional ApplicationControlData[]? data); void onfailure(); };
Since: 2.0
This callback interface specifies two methods:
onsuccess
void onsuccess(optional ApplicationControlData[]? data);
Since: 2.0
Parameters:
onfailure
void onfailure();
Since: 2.0
[Callback, NoInterfaceObject] interface ApplicationInformationEventCallback { void oninstalled(ApplicationInformation info); void onupdated(ApplicationInformation info); void onuninstalled(ApplicationId id); };
Since: 1.0
This callback interface specifies methods that are invoked when an application is installed, updated, or uninstalled.
oninstalled
void oninstalled(ApplicationInformation info);
Since: 1.0
Parameters:
onupdated
void onupdated(ApplicationInformation info);
Since: 1.0
Parameters:
onuninstalled
void onuninstalled(ApplicationId id);
Since: 1.0
Parameters:
module Application { typedef DOMString ApplicationId; typedef DOMString ApplicationContextId; [NoInterfaceObject] interface ApplicationManagerObject { readonly attribute ApplicationManager application; }; Tizen implements ApplicationManagerObject; [NoInterfaceObject] interface ApplicationManager { Application getCurrentApplication() raises(WebAPIException); void kill(ApplicationContextId contextId, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void launch(ApplicationId id, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void launchAppControl(ApplicationControl appControl, optional ApplicationId? id, optional SuccessCallback? successCallback, optional ErrorCallback? errorCallback, optional ApplicationControlDataArrayReplyCallback? replyCallback) raises(WebAPIException); void findAppControl(ApplicationControl appControl, FindAppControlSuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); void getAppsContext(ApplicationContextArraySuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); ApplicationContext getAppContext(optional ApplicationContextId? contextId) raises(WebAPIException); void getAppsInfo(ApplicationInformationArraySuccessCallback successCallback, optional ErrorCallback? errorCallback) raises(WebAPIException); ApplicationInformation getAppInfo(optional ApplicationId? id) raises(WebAPIException); ApplicationCertificate[] getAppCerts(optional ApplicationId? id) raises(WebAPIException); DOMString getAppSharedURI(optional ApplicationId? id) raises(WebAPIException); ApplicationMetaData[] getAppMetaData(optional ApplicationId? id) raises(WebAPIException); long addAppInfoEventListener(ApplicationInformationEventCallback eventCallback) raises(WebAPIException); void removeAppInfoEventListener(long watchId) raises(WebAPIException); }; [NoInterfaceObject] interface Application { readonly attribute ApplicationInformation appInfo; readonly attribute ApplicationContextId contextId; void exit() raises(WebAPIException); void hide() raises(WebAPIException); RequestedApplicationControl getRequestedAppControl() raises(WebAPIException); }; [NoInterfaceObject] interface ApplicationInformation { readonly attribute ApplicationId id; readonly attribute DOMString name; readonly attribute DOMString iconPath; readonly attribute DOMString version; readonly attribute boolean show; readonly attribute DOMString[] categories; readonly attribute Date installDate; readonly attribute long size raises(WebAPIException); readonly attribute PackageId packageId; }; [NoInterfaceObject] interface ApplicationContext { readonly attribute ApplicationContextId id; readonly attribute ApplicationId appId; }; [Constructor(DOMString key, DOMString[] value)] interface ApplicationControlData { attribute DOMString key; attribute DOMString[] value; }; [Constructor(DOMString operation, optional DOMString? uri, optional DOMString? mime, optional DOMString? category, optional ApplicationControlData[]? data)] interface ApplicationControl { attribute DOMString operation; attribute DOMString? uri; attribute DOMString? mime; attribute DOMString? category; attribute ApplicationControlData[] data; }; [NoInterfaceObject] interface RequestedApplicationControl { readonly attribute ApplicationControl appControl; readonly attribute ApplicationId callerAppId; void replyResult(optional ApplicationControlData[]? data) raises(WebAPIException); void replyFailure() raises(WebAPIException); }; [NoInterfaceObject] interface ApplicationCertificate { readonly attribute DOMString type; readonly attribute DOMString value; }; [NoInterfaceObject] interface ApplicationMetaData { readonly attribute DOMString key; readonly attribute DOMString value; }; [Callback=FunctionOnly, NoInterfaceObject] interface ApplicationInformationArraySuccessCallback { void onsuccess(ApplicationInformation[] informationArray); }; [Callback=FunctionOnly, NoInterfaceObject] interface FindAppControlSuccessCallback { void onsuccess(ApplicationInformation[] informationArray, ApplicationControl appControl); }; [Callback=FunctionOnly, NoInterfaceObject] interface ApplicationContextArraySuccessCallback { void onsuccess(ApplicationContext[] contexts); }; [Callback, NoInterfaceObject] interface ApplicationControlDataArrayReplyCallback { void onsuccess(optional ApplicationControlData[]? data); void onfailure(); }; [Callback, NoInterfaceObject] interface ApplicationInformationEventCallback { void oninstalled(ApplicationInformation info); void onupdated(ApplicationInformation info); void onuninstalled(ApplicationId id); }; };