com.webos.appInstallService

API Summary

This API carries out the application installation and provides information of the application being installed.

Overview of the API

Methods

dev/install

ACG: applicationinstall.devmode

Description

Installs an ipk file which exists in local repository of a device.

Note: This method is available only in developer mode (devmode). To enable devmode, call 'com.webos.service.devmode' ('setDevMode') with value 'true'.

Parameters

Name	Required	Type	Description
id	Required	String	ID of an app to be installed. Note: If an app is being installed with the same id, the request will be ignored.
ipkUrl	Required	String	The path of the ipk file to be installed. Note: This must be the absolute path of the file. For example, "/media/internal/downloads/com.yourdomain.app.ipk".
subscribe	Optional	Boolean	Subscribe and get notified when the status of installation changes. Possible values are: true - Subscribed for changes. false - Not subscribed.

Name

Required

Type

Description

Required

String

ID of an app to be installed.

Note: If an app is being installed with the same id, the request will be ignored.

ipkUrl

Required

String

The path of the ipk file to be installed.

Note: This must be the absolute path of the file. For example, "/media/internal/downloads/com.yourdomain.app.ipk".

Optional

Boolean

Subscribe and get notified when the status of installation changes. Possible values are:

true - Subscribed for changes.
false - Not subscribed.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
subscribed	Required	Boolean	Indicates if subscribed to get notified. true - Subscribed for changes false - Not subscribed
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

Subscription Returns

Name	Required	Type	Description
id	Required	String	ID of the app that is being installed.
statusValue	Required	Number	The current installation status. See the statusValue parameter (in Subscription Return) of the install method for more information.
details	Required	Object: details	Contains detailed information of the progress of installation.

Name

Required

Type

Description

Required

String

ID of the app that is being installed.

statusValue

Required

Number

The current installation status.

See the statusValue parameter (in Subscription Return) of the install method for more information.

details

Required

Object: details

Contains detailed information of the progress of installation.

Example

Example code

# luna-send -i -f luna://com.webos.appInstallService/dev/install '{
  "id":"my_first_app",
  "ipkUrl":"/media/internal/downloads/com.test.app.hello_0.0.1_all.ipk",
  "subscribe":true
}'

dev/remove

ACG: applicationinstall.devmode

Description

Removes apps from a device that are installed using dev/install method.

Note: This method is available only in developer mode (devmode). To enable devmode, call 'com.webos.service.devmode' ('setDevMode') with value 'true'.

Parameters

Name	Required	Type	Description
id	Required	String	ID of the app to be removed.
subscribe	Required	Boolean	Subscribe and get notified when the app removal status changes. Possible values are: true - Subscribed for changes. false - Not subscribed.

Name

Required

Type

Description

Required

String

ID of the app to be removed.

Required

Boolean

Subscribe and get notified when the app removal status changes. Possible values are:

true - Subscribed for changes.
false - Not subscribed.

Call Returns

Name	Required	Type	Description
returnVaue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
subscribed	Required	Boolean	Indicates if subscribed to get notified. true - Subscribed for changes false - Not subscribed
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

Subscription Returns

Name	Required	Type	Description
id	Required	String	ID of the app that is being removed.
statusValue	Required	Number	The current app removal status. See the statusValue parameter (in Subscription Return) of the install method for more information.
details	Required	Object: details	Contains detailed information of the app removal progress.

Name

Required

Type

Description

Required

String

ID of the app that is being removed.

statusValue

Required

Number

The current app removal status.

See the statusValue parameter (in Subscription Return) of the install method for more information.

details

Required

Object: details

Contains detailed information of the app removal progress.

Example

Example code

# luna-send -i -f luna://com.webos.appInstallService/dev/remove '{
"id":"my_first_app",
"subscribe":true
}'

install

ACG: applicationinstall.management

Description

Installs an app on a device.

Parameters

Name	Required	Type	Description
id	Required	String	ID of the app to be installed. Note: The ID must be unique.
subscribe	Optional	Boolean	Subscribe and get notified when the installation status changes. Possible values are: true - Subscribed for changes. false - Not subscribed.
ipkUrl	Required	String	The path of the ipk file to be installed. Note: This must be the absolute path. For example, "/media/internal/downloads/com.yourdomain.app.ipk".

Name

Required

Type

Description

Required

String

ID of the app to be installed.

Note: The ID must be unique.

Optional

Boolean

Subscribe and get notified when the installation status changes. Possible values are:

true - Subscribed for changes.
false - Not subscribed.

ipkUrl

Required

String

The path of the ipk file to be installed.

Note: This must be the absolute path. For example, "/media/internal/downloads/com.yourdomain.app.ipk".

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
subscribed	Required	Boolean	Indicates if subscribed to get notified. true - Subscribed for changes false - Not subscribed
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

Subscription Returns

Name	Required	Type	Description
id	Required	String	ID of the app to be installed.
statusValue	Required	Number	The current installation status. Possible values are: 0 - Unknown 6 - Need to download ipk file 7 - Request download ipk to luna-downloadmgr 8 - Download ipk file is on progressing 10 - Download ipk is complete 11 - Need to install ipk file 12 - Request install ipk file to applicationinstallerutility 13 - Installing ipk file is starting 17 - Installing ipk is complete 18 - Need to remove ipk file 19 - Request remove ipk file to applicationinstallerutility 21 - Removing ipk is complete 22 - Install operation is cancelled 23 - Install operation is complete with error during download 24 - Install operation is complete with error during installing ipk 25 - Remove operation is complete with error 26 - appinstalld internal status. It'll be deprecated. 27 - Need to install role & service files 28 - Request install role & service files internally 29 - Installing role & service files is complete 30 - All install operations are complete successfully 31 - All remove operations are complete successfully 32 - Need to close app 33 - Request close app to sam 34 - App close is complete 35 - Need to parse ipk file 36 - Request parse ipk file internally 37 - Parsing ipk file is complete 38 - Need to remove role & service files 39 - Request remove role & service files internally 40 - Remove role & service files is complete 41 - Prepare to remove app 42 - Start to remove app 256 - Need to install right object 257 - Request installing right object to securitymanager 258 - Installing right object is complete 259 - Need to uninstall right object 260 - Request uninstalling right object to securitymanager 261 - Uninstalling right object is complete 262 - Need to get ipk information from server 263 - Request ipk information to server 264 - Getting ipk information is complete 265 - Need to post install done message 266 - Request post install done to server 267 - Posting install done is complete 268 - Need to verify ipk file 269 - Request verify ipk file to securitymanager 270 - Verifying ipk file is complete
details	Required	Object: details	Contains detailed information of the progress of installation.
installDataPath	Required	String	Temporary data path that is being used during installation.

Example

Example code

# luna-send -i -f luna://com.webos.appInstallService/install '{
"id":"com.test.app.hello",
"ipkUrl":"/media/internal/downloads/com.test.app.hello_0.0.1_all.ipk",
"subscribe":true
}'

Example response for a successful call:

{
"subscribed": true,
"returnValue": true
}

Example response for a failed call:

{
"subscribed": false,
"errorCode": -2,
"returnValue": false,
"errorText": "Missing required key is required but it is missing"
}

remove

ACG: applicationinstall.management

Description

Removes an installed app from a device.

Parameters

Name	Required	Type	Description
id	Required	String	ID of the app to be removed.
subscribe	Optional	Boolean	Subscribe and get notified when the app removal status changes. Possible values are: true - Subscribed for changes. false - Not subscribed.

Name

Required

Type

Description

Required

String

ID of the app to be removed.

Optional

Boolean

Subscribe and get notified when the app removal status changes. Possible values are:

true - Subscribed for changes.
false - Not subscribed.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details
subscribed	Required	Boolean	Indicates if subscribed to get notified. true - Subscribed for changes false - Not subscribed
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

Subscription Returns

Name	Required	Type	Description
id	Required	String	ID of the app to be removed.
statusValue	Required	Number	The current app removal status. See the statusValue parameter (in Subscription Return) of the install method for more information.
details	Required	Object: details	Contains detailed information of the progress of app removal.

Name

Required

Type

Description

Required

String

ID of the app to be removed.

statusValue

Required

Number

The current app removal status.

See the statusValue parameter (in Subscription Return) of the install method for more information.

details

Required

Object: details

Contains detailed information of the progress of app removal.

Example

Example code

# luna-send -i -f luna://com.webos.appInstallService/remove '{
"id":"com.test.app.hello",
"subscribe":true
}'

Example response for a successful call:

{
"subscribed": true,
"returnValue": true
}

Example response for a failed call:

{
    "subscribed": false,
    "errorCode": -2,
    "returnValue": false,
    "errorText": "Missing required key is required but it is missing"
}

status

ACG: applicationinstall.management

Description

Monitors the status of all installed and removed apps that are operating in the com.webos.appInstallService.

Parameters

Name	Required	Type	Description
subscribe	Optional	Boolean	Subscribe and get notified when the status changes. Possible values are: true - Subscribed for changes. false - Not subscribed.

Name

Required

Type

Description

Optional

Boolean

Subscribe and get notified when the status changes. Possible values are:

true - Subscribed for changes.
false - Not subscribed.

Call Returns

Name	Required	Type	Description
returnValue	Required	Boolean	Indicates the status of operation. Possible values are: true - Indicates that the operation was successful. false - Indicates that the operation failed. Check the "errorCode" and "errorText" fields for details.
subscribed	Required	Boolean	Indicates if subscribed to get notified. true - Subscribed for changes false - Not subscribed
status	Required	Object: status	Contains the list of apps that are currently being installed and removed.
errorCode	Optional	Number	The error code for the failed operation.
errorText	Optional	String	Indicates the reason for the failure of the operation. See the "API Error Codes Reference" section for details.

Subscription Returns

Name	Required	Type	Description
id	Required	String	ID of the app to be installed or removed.
statusValue	Required	Number	The current app status. See the statusValue parameter (in Subscription Return) of the install method for more information.
details	Required	Object: details	Contains detailed information of app statuses.
installDataPath	Optional	String	Temporary data path that is being used during installation.

Example

Example code

# luna-send -n 1 -f luna://com.webos.appInstallService/status '{}'

Response:

{
  "subscribed": true,
  "status": {
  "apps": []
  },
  "returnValue": true
}

Objects

details

The object describes the progress on all operations that are managed by the com.webos.appInstallService.

Name	Required	Type	Description
packageId	Optional	String	Package ID extracted from a control file within an ipk file.
verified	Optional	Boolean	This indicates whether an app is verified by App Server or not. If this is false, an app is to be installed internally such as a secure developer mode.
progress	Optional	Number	The download progress of an ipk file from 0 to 100.
installBasePath	Optional	String	The base path where an app is installed.
state	Optional	String	State of the requested progress.
update	Optional	Boolean	This indicates whether the operation is to update an app or not when installing an app.
client	Optional	String	Client who calls the operation request.

status

The object contains all operations' status that is managed by the com.webos.appInstallService.

Name	Required	Type	Description
apps	Required	Object array: details	The details object indicates the detailed information of all operation progress.

API Error Codes Reference

Error Code	Error Text	Error Description
0	None	Success
-1	General error text is displayed such as "fail to extract ipk file", "fail to install service file", "unable to call ApplicationInstallerUtility" and so on.	General error during app installation request.
-2	The same error text will be displayed as a system generates. The error occurs when an invalid parameter type or an invalid parameter value is passed.	Invalid parameter.
-7	The same error text will be displayed as a system or another service generates. The error text is passed when an error occurs during removing an app.	Remove operation error during app removal.